Payout Notifications

Webhook notifications:

Notification Type	Details	Payload
PAYOUT_FAILED	Triggered whenever there is a problem with the payout. This can occur due to multiple reasons, such as the destination PIX key is active but the bank account associated with it is not, or any other regulatory reason.	type: 'PAYOUT_FAILED' data: data.id: string data.accountId: string data.type: string data.amount: string data.status: string data.externalId: string data.transactionId: string data.transactionEndToEndId: string
PAYOUT_CREATED	Triggered when the payout is successfully created, which means the bank has received the payout order and will return an updated status of either sucessfully completed or failed.	type: 'PAYOUT_CREATED' data: data.id: string data.accountId: string data.type: string data.amount: string data.status: string data.externalId: string data.transactionId: string data.transactionEndToEndId: string
PAYOUT_COMPLETED	Triggered when the payout is successfully sent to the destination account.	type: 'PAYOUT_COMPLETED' data: data.id: string data.accountId: string data.type: string data.amount: string data.status: string data.externalId: string data.transactionId: string data.transactionEndToEndId: string
PAYOUT_REFUNDED	Triggered when a PIX refund is received, being either a partial one or a complete refund. This notification brings a reference to the payout that was refunded and the data of the refunded transaction.	type: 'PAYOUT_REFUNDED' data: data.originalPayout: data.originalPayout.id: string data.accountId: string data.originalPayout.type: string data.originalPayout.amount: number data.originalPayout.status: string data.originalPayout.externalId: string data.originalPayout.transactionId: string data.originalPayout.transactionEndToEndId: string data.refundData: data.refundData.amount: number data.refundData.transactionId: string data.refundData.transactionEndToEndId: string

Webhook Payload Key, Data Types, Details and Examples

Key	Data Types	Details	Examples
type	String	Webhook notification type. "PAYOUT_CREATED" "PAYOUT_COMPLETED" "PAYOUT_REFUNDED" "PAYOUT_FAILED"	"type": "PAYOUT_CREATED"
data	Object	Contains operational information	"data": { }
data.id	String	Payout ID	"id": "c0eb14aa-ef4a-4b36-97cf-f95fffd23d67"
data.accountId	String	Account Identifier	"accountId": "acc_01..."
data.externalId	String	Used to identify a Payout	"externalId": "cmpny_n0shrtshrlk"
data.amount	Int(32)	Operation value in cents	"amount": 1000 (1000 = 10.00)