Skip to main content
PUT
/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required
accountId
string
required
walletId
string
required
boletoId
string
required

Body

application/json
amount
integer
required
Required range: 0 < x <= 9007199254740991
category
enum<string>
required
Available options:
FLEX_NATIONAL,
FLEX_INTERNATIONAL,
FOOD,
GAS,
MOBILITY,
TOLL,
FLEX_NATIONAL_WITHOUT_WITHDRAWALS,
ADS,
SAAS,
HOTEL,
AIRLINES,
TRAVEL
description
string
customFields
object
scheduledAt
string<date-time>
timeZone
string

Response

200 - application/json

Successful response

_id
string
required
environment
enum<string>
required
Available options:
LIVE,
TEST
realmId
string
required
organizationId
string
required
accountId
string
required
walletId
string
required
barcode
string
required
status
enum<string>
required
Available options:
REQUESTED,
PENDING_APPROVAL,
CANCELLED,
PAID,
FAILED,
REFUNDED,
SCHEDULED,
EXPIRED
txnCurrency
enum<string>
required
Available options:
784,
971,
008,
051,
973,
032,
036,
533,
944,
977,
052,
050,
048,
108,
060,
096,
068,
984,
986,
044,
064,
072,
933,
084,
124,
976,
947,
756,
948,
990,
152,
156,
170,
970,
188,
192,
132,
203,
262,
208,
214,
012,
818,
232,
230,
978,
242,
238,
826,
981,
936,
292,
270,
324,
320,
328,
344,
340,
332,
348,
360,
376,
356,
368,
364,
352,
388,
400,
392,
404,
417,
116,
174,
408,
410,
414,
136,
398,
418,
422,
144,
430,
426,
434,
504,
498,
969,
807,
104,
496,
446,
929,
480,
462,
454,
484,
979,
458,
943,
516,
566,
558,
578,
524,
554,
512,
590,
604,
598,
608,
586,
985,
600,
634,
946,
941,
643,
646,
682,
090,
690,
938,
752,
702,
654,
925,
706,
968,
728,
930,
222,
760,
748,
764,
972,
934,
788,
776,
949,
780,
901,
834,
980,
800,
840,
997,
940,
858,
927,
860,
926,
928,
704,
548,
882,
396,
950,
961,
959,
955,
956,
957,
958,
951,
532,
960,
952,
964,
953,
962,
994,
963,
965,
999,
886,
710,
967,
924
txnMaxAmount
number
required
txnMinAmount
number
required
txnOriginalAmount
number
required
txnDiscountAmount
number
required
txnFineAmount
number
required
txnInterestAmount
number
required
txnUpdatedAmount
number
required
issuer
string
required
payee
string
required
payeeDocument
string
required
payer
string
required
payerDocument
string
required
type
enum<string>
required
Available options:
GENERIC,
UTILITY_BILL
external
object
required
processingType
enum<string>
required
Available options:
INSTANT,
DELAYED
policy
object
required

Transient, never persisted — the ADVISORY business-policy evaluation for the parameters just stored. This is the point of the endpoint. A boleto is created before the user has entered an amount, so the CREATE response's advisory policy can never match an amount-based condition; this one can, and it is what tells the client whether a confirm will need approval.

Fail-open and ALWAYS present: an unreachable evaluator answers { error: "POLICY_EVALUATION_UNAVAILABLE" }, never an absent key.

receipt
object
confirmedAt
string
confirmedAmount
number
confirmedBalanceCategory
enum<string>
Available options:
FLEX_NATIONAL,
FLEX_INTERNATIONAL,
FOOD,
GAS,
MOBILITY,
TOLL,
FLEX_NATIONAL_WITHOUT_WITHDRAWALS,
ADS,
SAAS,
HOTEL,
AIRLINES,
TRAVEL,
BLOCKED,
CASHBACK
dueDate
string
expiresAt
string
canceledAt
string
settlesAt
string
refundedAt
string
scheduledAt
scheduledTimeZone
string | null
scheduleId
string | null
policyRequestId
string
autoResolutionRequestedAt

When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution.

autoResolutionInFlightUntil

While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain.

approvalExpiresAt
pendingConfirmation
object

The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by PUT .../{id}, and executed by a payload-less confirm/request. A stored set that is missing its category cannot be executed yet — confirm/request answer 422 PAYMENT_PARAMETERS_MISSING until a PUT completes it.

requester
object

Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed.

customFields
object
createdAt
string
updatedAt
string