Your postback notification for a banking payin.

POST

/order/example-postback-to-banking-order-payin/[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

Internal order identifier.

string

Example

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

code

required

External order code informed at creation time.

string

Example

payin-12345

event

required

Webhook event for BANKING PAYIN.

string

Allowed values: ORDER-PAYIN.PAID ORDER-PAYIN.EXPIRED ORDER-PAYIN.CANCELED ORDER-PAYIN.ERROR

Example

ORDER-PAYIN.PAID

status

required

Current order status for BANKING PAYIN.

string

Allowed values: PAID EXPIRED CANCELED ERROR

Example

PAID

paidAt

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

string

nullable

Example

2026-02-19T13:32:21.552Z

updatedAt

required

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

string

Example

2026-02-19T13:32:21.552Z

endToEndId

PIX endToEndId when provided by the financial partner.

string

nullable

Example

E12345678202602191332a1b2c3d4e5f

type

required

Webhook type.

string

Allowed values: PAY-IN

Example

PAY-IN

message

required

Human-readable status message.

string

Example

Order paid

customerMessage

Message for the customer.

string

Example

Pix payment

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

Destination 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

payer

required

Payer 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

Responses

200

The resource was returned successfully

object

returnCode

required

The current page.

string

Example

SUCCESS