Your postback notification for a banking payout.

POST

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

• Sandbox

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.

Request Body ^required

object

id

required

Internal order identifier.

string

code

required

External order code informed at creation time.

string

event

required

Webhook event for BANKING PAYOUT.

string

Allowed values: ORDER-PAYOUT.PAID ORDER-PAYOUT.CANCELED ORDER-PAYOUT.ERROR

status

required

Current order status for BANKING PAYOUT.

string

Allowed values: PAID CANCELED ERROR

paidAt

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

string

nullable

updatedAt

required

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

string

endToEndId

PIX endToEndId when provided by the financial partner.

string

nullable

type

required

Webhook type.

string

Allowed values: PAY-OUT

message

required

Human-readable status message.

string

description

Additional information provided at order creation.

string

amount

required

Order amount.

object

currency

required

Currency code

string

Allowed values: BRL

value

required

Amount value as numeric string

string

ownerBank

Origin account (owner) information when available.

object

name

Owner name.

string

document

Owner document number.

string

bank

Owner bank account data.

object

ispb

Bank ISPB code.

string

name

Bank name.

string

branch

Branch number.

string

account

Account number.

string

accountType

Account type informed by the financial partner.

string

code

Bank code (e.g. COMPE).

string

pix

PIX data when available.

object

type

required

The type of pix

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

key

required

The key of pix

string

receiver

required

Receiver information.

object

name

required

Full name of payer/receiver.

string

document

required

Document of payer/receiver.

object

type

required

Document type

string

Allowed values: CPF CNPJ

number

required

Document number

string

bank

Bank information of payer/receiver.

object

ispb

Bank ISPB code.

string

name

Bank name.

string

branch

Branch number.

string

account

Account number.

string

accountType

Account type informed by the financial partner.

string

code

Bank code (e.g. COMPE).

string

pix

PIX data when available.

object

type

required

The type of pix

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

key

required

The key of pix

string

Responses

200

The resource was returned successfully

object

returnCode

required

The current page.

string