Skip to content

Your postback notification for a banking payout.

POST
/order/example-postback-to-banking-order-payout/[your_notification_url]

Every time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.

We expect that your system returns to ours: status code 200. If not, we’ll retry 6 more times.

object
id
required

Internal order identifier.

string
Example
8ba1d4ff-2bc2-45c7-8e60-ec57ab9931de
code
required

External order code informed at creation time.

string
Example
payout-12345
event
required

Webhook event for BANKING PAYOUT.

string
Allowed values: ORDER-PAYOUT.PAID ORDER-PAYOUT.CANCELED ORDER-PAYOUT.ERROR
Example
ORDER-PAYOUT.PAID
status
required

Current order status for BANKING PAYOUT.

string
Allowed values: PAID CANCELED ERROR
Example
PAID
paidAt

Date when order was paid (UTC ISO-8601).

string
nullable
Example
2026-02-19T13:34:18.177Z
updatedAt
required

Date of the status transition (UTC ISO-8601).

string
Example
2026-02-19T13:34:18.177Z
endToEndId

PIX endToEndId when provided by the financial partner.

string
nullable
Example
E12345678202602191334z9y8x7w6v5u
type
required

Webhook type.

string
Allowed values: PAY-OUT
Example
PAY-OUT
message
required

Human-readable status message.

string
Example
Order paid
description

Additional information provided at order creation.

string
Example
Order description
amount
required

Order amount.

object
currency
required

Currency code

string
Allowed values: BRL
Example
BRL
value
required

Amount value as numeric string

string
Example
10.00
ownerBank

Origin account (owner) information when available.

object
name

Owner name.

string
Example
Empresa Exemplo LTDA
document

Owner document number.

string
Example
12345678000199
bank

Owner bank account data.

object
ispb

Bank ISPB code.

string
Example
12345678
name

Bank name.

string
Example
Banco Exemplo S.A.
branch

Branch number.

string
Example
0001
account

Account number.

string
Example
1234567
accountType

Account type informed by the financial partner.

string
Example
CHECKING_ACCOUNT
code

Bank code (e.g. COMPE).

string
Example
237
pix

PIX data when available.

object
type
required

The type of pix

string
Allowed values: CPF CNPJ EMAIL PHONE RANDOM
Example
CPF
key
required

The key of pix

string
Example
1234567890
receiver
required

Receiver information.

object
name
required

Full name of payer/receiver.

string
Example
Joao da Silva
document
required

Document of payer/receiver.

object
type
required

Document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

Document number

string
Example
12345678901
bank

Bank information of payer/receiver.

object
ispb

Bank ISPB code.

string
Example
12345678
name

Bank name.

string
Example
Banco Exemplo S.A.
branch

Branch number.

string
Example
0001
account

Account number.

string
Example
1234567
accountType

Account type informed by the financial partner.

string
Example
CHECKING_ACCOUNT
code

Bank code (e.g. COMPE).

string
Example
237
pix

PIX data when available.

object
type
required

The type of pix

string
Allowed values: CPF CNPJ EMAIL PHONE RANDOM
Example
CPF
key
required

The key of pix

string
Example
1234567890

The resource was returned successfully

object
returnCode
required

The current page.

string
Example
SUCCESS