Skip to main content
POST
/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm

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
pixId
string
required

Body

application/json
processingType
enum<string>
required
Available options:
INSTANT,
DELAYED
retryCount
integer
default:0
Required range: -9007199254740991 <= x <= 9007199254740991
customFields
object

Response

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
creditParty
object
required
debitParty
object
required
description
string
required
direction
string
required
receipt
object
required
initiationType
enum<string>
required
Available options:
MANUAL,
DICT,
STATIC_QRCODE,
DYNAMIC_QRCODE,
UNDEFINED_QRCODE,
COPY_PASTE,
FULL_BANK_DETAILS,
REVERSAL,
AUTOMATIC_PIX,
PAYMENT_INITIATOR
status
enum<string>
required
Available options:
REQUESTED,
CANCELLED,
CONFIRMED,
PAID,
FAILED,
REFUNDED
transactionType
enum<string>
required
Available options:
TRANSFER,
CHANGE,
WITHDRAWAL,
PAYMENT
txnCurrency
enum<string>
required
Available options:
356,
978,
710,
967,
932,
953,
704,
937,
548,
860,
940,
858,
800,
980,
036,
949,
934,
840,
788,
780,
776,
554,
952,
834,
972,
901,
764,
941,
951,
678,
578,
947,
756,
948,
752,
968,
728,
938,
748,
144,
706,
994,
532,
690,
694,
925,
882,
654,
504,
646,
946,
760,
214,
203,
950,
826,
404,
417,
634,
985,
604,
965,
600,
586,
598,
590,
512,
566,
558,
524,
516,
484,
979,
104,
943,
496,
498,
480,
478,
458,
462,
454,
969,
807,
446,
434,
422,
430,
426,
418,
414,
400,
392,
388,
886,
376,
352,
364,
368,
360,
090,
208,
238,
136,
348,
344,
340,
332,
270,
324,
328,
320,
292,
981,
936,
960,
608,
242,
643,
230,
997,
232,
784,
222,
818,
262,
931,
192,
191,
188,
408,
410,
976,
174,
170,
970,
702,
156,
990,
152,
398,
124,
116,
132,
064,
108,
975,
096,
986,
072,
977,
984,
068,
060,
084,
974,
052,
050,
048,
044,
944,
682,
533,
051,
012,
032,
008
txnAllowAmountChange
boolean
required
txnOriginalAmount
number
required
txnDiscountAmount
number
required
txnFineAmount
number
required
txnInterestAmount
number
required
txnPurchaseAmount
number
required
txnWithdrawalAmount
number
required
txnUpdatedAmount
number
required
external
object
required
requester
object

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

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 | null
expiresAt
string | null
canceledAt
string | null
refundedAt
string | null
qrCodeType
enum<string>
Available options:
STATIC,
COB,
COBV
pixCopyPaste
string
qrQrCodeActive
boolean
additionalInfo
object[]
withdrawal
object
processingType
enum<string>
Available options:
INSTANT,
DELAYED
createdAt
string
updatedAt
string