Your postback notification for an order.

POST

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

• Production
• 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

The id of the order of which to retrieve the details.

string

Example

de05f0db-e6a3-462e-8f1c-8dc8dd07c278

code

required

Order id in your system.

string

Example

2345678726

status

required

Order status.

string

Allowed values: PENDING PAID EXPIRED REFUNDED CANCELED ERROR

Example

PAID

paidAt

required

The date the order was paid.

string

Example

2022-12-17T11:35:51.923Z

updatedAt

required

The date the order was updated.

string

Example

2022-12-17T11:35:51.923Z

type

required

The webhook order type.

string

Allowed values: PAY-IN PAY-OUT REFUND

Example

PAY-IN

message

The message.

string

Example

Order paid

customerMessage

The message for the customer.

string

Example

Pix payment

amount

required

Amount of the order

object

currency

required

The three-character ISO currency code.

https://en.wikipedia.org/wiki/ISO_4217

string

Allowed values: BRL USD ARS EUR CLP COP MXN PEN BUSD USDT

Example

BRL

value

required

The amount of the transaction, in minor units.

Minor Units Format
------------------

All amount values must be formatted in that currency’s smallest unit.
Two-decimal currency (for example Real): R$ 10,95 BRL, amount will be "10.95".
Two-decimal currency (for example US Dollars): $10.95 USD, amount will be "10.95".
Zero-decimal currency (for example Japanese Yen): ¥1095 JPY, amount will be "1095".
Click here to download the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency.    

string

Example

10.95

ownerBank

The owner bank. Returns data only when payment method is PIX

object

name

The name of the owner.

string

Example

John Doe

document

The document of the owner.

string

Example

12345678901

bank

The bank information of owner.

object

name

The bank name.

string

Example

Financial Bank

ispb

The bank ISPB code.

string

Example

00123876

code

The bank code, like COMPE.

string

Example

123

account

The account number.

string

Example

12345-2

branch

The branch account number.

string

Example

0001

pix

The pix.

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

payer

The payer bank data.

object

ispb

Bank ISPB number

string

Example

12345678

name

Bank name

string

Example

Bank name

branch

Bank branch account number

string

Example

1234

account

Bank account number

string

Example

123456

accountType

Bank account type

string

Allowed values: CHECKING_ACCOUNT WAGE_ACCOUNT SAVINGS_ACCOUNT PAYMENT_ACCOUNT

Example

CHECKING_ACCOUNT

code

Bank code (COMPE)

string

Example

341

pix

Bank pix data

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

Responses

200

The resource was returned successfully

object

returnCode

required

The current page.

string

Example

SUCCESS