Webhook V4 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

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
]
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
]
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
]