Asynchronous Events

id

string

All States

An UID that uniquely identifies the event

transactionState

string

All States

The current transaction state as one of: Registered, Cancelled, Completed, Reversed or Error

transactionDate

string

All States

The transaction request date

transactionOrderId

string

All States

The order identification sent by the integrator during the transaction request

transactionReceipt

string

Completed

The transaction receipt URL, once this webhook notifies a complete transaction

transactionReceiptDate

string

Completed

The payment receipt issue date

transactionReceiptVoucher

string

Completed

A payment code provided by the Bank of Emission.

transactionAmount

string

All States

The value of the origin transaction

transactionCharges

string

Completed

The changes applicable to the transaction

transactionType

string

All States

Transaction Type, Credit for Cash In, or Debit for Cash Out

transactionPaymentType

string

All States

Payment type (e.g. PIX).

stateRegisteredDate

string

All States

The date for the intermediary state when the transaction is registered with the bank

stateCancelledDate

string

Canceled

The date of a transaction canceling if the transaction state is Canceled. Empty otherwise

stateCompletedDate

string

Completed

The date of a transaction completion if the transaction state is Completed. Empty otherwise

stateRefundDate

string

None

The date of a transaction refund if the transaction state is Refunded. Empty otherwise.

• *Note**: Refund state is included in the API but can not be reached. If you have doubts, please read the discussion about refunds in the transaction lifecycle section.

stateReversedDate

string

Reversed

The date of a transaction rollback if the transaction state is Reversed. Empty otherwise.

• *Note**: Rollback state only applies to transactions in intermediate states, not transactions in final state.

stateErrorDate

string

Error

The date of a transaction error if the transaction state is Error. Empty otherwise

stateErrorCause

string

Error

A key for an error description if the state is Error. Empty otherwise.
For a full list of errors, please refer to our Errors Identifiers in the Platform Errors guide.

webhookUrl

string

All States

The Webhook notification URL

payer.name

string

Completed

The account owner name

payer.taxNumber

string

Completed

The account owner document number

payer.bankCode

string

Completed

The payer bank code as defined by the Central Bank authority in Brazil

payer.bankIspb

string

Completed

A payer six-digit code used to uniquely identify payment institutions in Brazil (if available)

payer.bankName

string

Completed

The payer institution name (if available)

payer.accountAgency

string

Completed

The payer bank account agency (if available)

payer.accountNumber

string

Completed

The payer bank account number (if available)

payer.accountDigit

string

Completed

The payer bank account verification digit (if available)

payer.accountType

string

Completed

A text with one of the following: CheckingAccount, SavingsAccount or SalaryAccount (if available)

recipient.name

string

Completed

The recipient account owner name

recipient.taxNumber

string

Completed

The account owner document number

recipient.bankCode

string

Completed

The recipient bank code as defined by the Central Bank authority in Brazil

recipient.bankIspb

string

Completed

The recipient six-digit code used to uniquely identify payment institutions in Brazil (if available)

recipient.bankName

string

Completed

The recipient institution name (if available)

recipient.accountAgency

string

Completed

The recipient bank agency (if available)

recipient.accountNumber

string

Completed

The recipient bank account number (if available)

recipient.accountDigit

string

Completed

The recipient bank account verification digit (if available)

recipient.accountType

string

Completed

A text with one of the following: CheckingAccount, SavingsAccount or SalaryAccount (if available)