Payment Notifications

Webhook notifications:

Notification Type	Details	Payload
PAYMENT_APPROVED	Triggered when a payment gets successfully paid.	type: 'PAYMENT_APPROVED' data: data.id: number data.accountId: string data.externalId: string data.ownerDocument: string data.amount: number data.status: string data.transactionEndToEndId: string data.paymentOrigin: data.paymentOrigin.name: string data.paymentOrigin.document: string data.paymentOrigin.bankNumber: string data.paymentOrigin.branchNumber: string data.paymentOrigin.accountNumber: string data.paymentOrigin.pspId: string data.paymentOrigin.accountType: string data.paymentOrigin.accountDigit: string
PAYMENT_REFUNDED	Triggered when a payment gets refunded.	type: 'PAYMENT_REFUNDED' data: data.id: number data.accountId: string data.ownerDocument: string data.amount: number data.status: string data.externalId: string data.transactionEndToEndId: string data.paymentOrigin: data.paymentOrigin.name: string data.paymentOrigin.pspId: string data.paymentOrigin.document: string data.paymentOrigin.bankNumber: string data.paymentOrigin.accountType: string data.paymentOrigin.branchNumber: string data.paymentOrigin.accountNumber: string data.paymentOrigin.accountDigit: string
PAYMENT_EXPIRED	Triggered when a payment expires, transaction was not paid in predefined timeout.	type: 'PAYMENT_EXPIRED' data: data.id: number data.accountId: string data.ownerDocument: string data.amount: number data.status: string data.externalId: string

Webhook Payload Key, Data Types, Details and Examples

Key	Data Type	Details	Example
type	String	Webhook notification type. "PAYMENT_APPROVED", "PAYMENT_REFUNDED", "PAYMENT_EXPIRED"	"type": "PAYMENT_APPROVED"
data	Object	Contains operational information	"data": { }
data.id	Number (Int32)	Payment ID	"id": 10398
data.accountId	String	Account Identifier	"acc_01..."
data.externalId	String	Used to identify a Payment	"externalId": "tnx_n0shrtshrlk"
data.amount	Number (Int32)	Operation value in cents	"amount": 1000 (1000 = 10.00)
data.transactionEndToEndId	String		"transactionEndToEndId": "E23114447202501231106H4bymh2lXgW"
data.ownerDocument	String	Document is collected in paymentOrigin	"28094443073"
data.status	String	Operation status	"status": "PAID"
data.paymentOrigin	Object	Contains payer account information	"paymentOrigin" { }
data.paymentOrigin.name	String	Payer's name as in bank account	"name": "John Doe"
data.paymentOrigin.document	String	Payer's document as in account, CPF for Physical Person or CNPJ for Legal Person	CPF "document": "28094443073" CNPJ "document": "41157331000117"
data.paymentOrigin.bankNumber	String	Payer's bank number	"bankNumber": "450"
data.paymentOrigin.branch	String	Payer's bank branch	"branch": "0001"
data.paymentOrigin.accountNumber	String	Payer's account number	"accountNumber": "320781"
data.paymentOrigin.pspId	String	Payer's PSP ID	"pspId": "13370835" "pspId": "NOT INFORMED"
data.paymentOrigin.accountType	String	Payer's account type. CC: Checking Accounts CP: Saving Accounts IP: Payment Institution Accounts UNKNOWN: Unknown source	"accountType": "CC"
data.paymentOrigin.accountDigit	String	Payer's account digit.	"6"