Webhook V6 payload

Webhook payload

status status (string)required

Possible values: [paid, failed]

Transaction status

webhook_type webhook_type (string)required

Possible values: [transaction, withdraw, refund]

Transaction type

transaction_uuid transaction_uuid (string)required

Transaction UUID

error_code error_code (string)

Code related to the error occurred to the operation

description description (string)

Transaction description

value value (string)required

Transaction value

payment_date payment_date (string)

Payment date

merchant_id merchant_id (string)

Reference of the store that solicitate the action

end_to_end_id end_to_end_id (string)required

End to end id of the transaction

client object[]nullable
Information about the client
Array [
name string
Client's name
cpf_cnpj string
Client's document
]
payer object[]nullable
Information about who paid (exists when transaction_type is transaction)
Array [
name string
Payer's name
cpf_cnpj string
Payer's document
bank_name string
Payer's bank
bank_ispb string
Payer's bank ISPB
paid_by_client boolean
Tells if the client and the payer are the same person
kyc object[]
KYC information about the payer
Array [
birthdate birthdate (string)
Person's birth date
ofLegalAge ofLegalAge (boolean)
Client is of legal age
age age (integer)
Client's age
suspectedDeath suspectedDeath (boolean)
Tells if client has died
pep pep (boolean)
Tells if client is politically exposed
]
]
receiver object[]nullable
Information about who received the money (exists when transaction_type is withdraw or refund)
Array [
name string
Receiver's name
cpf_cnpj string
Receiver's document
bank_name string
Receiver's bank
bank_ispb string
Receiver's bank ISPB
]
refund object[]nullable
Information if deposit was refunded (exists when transaction_type is refund)
Array [
transaction_parent_uuid string
UUID of the main transaction
transaction_parent_merchant_id string
Merchant ID of the main transaction
error_code string
Possible values: [ISPB_NOT_IN_PERMISSION_LIST, INVALID_PAID_VALUE, INVALID_PAYER_DOCUMENT, KYC_RESTRICTION, INVALID_PAYER_BANK_ACCOUNT, INVALID_DEPOSIT_FROM_JURIDIC_PERSON]
Code related to the reason the deposit was had to be refunded
error_description string
Description for the error code
is_manual_refund boolean
Indicates whether refund was created from an API request or the gateway itself created it due to any business rules
]
bank_account_data object[]nullable
Information about the payer's bank account
Array [
bank_name string
Bank's name
bank_ispb string
Bank's ISPB
account_number string
Payer's account number
account_branch string
Payers's account branch
account_type string
Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS]
Payer's account type
]