External Deposit Notification
Webhook notifications:
EXTERNAL_DEPOSIT
Triggered when an external deposit is made to the account directly using the PIX key, without creating a PayIn.
type: 'EXTERNAL_DEPOSIT' data: data.statementId: string data.debtorDocument: string data.debtorName: string data.amount: number data.debtorAccount: data.debtorAccount.bank: string data.debtorAccount.branch: string data.debtorAccount.number: string
Webhook Payload Key, Data Type, Details and Examples
type
String
Identifies the event type.
"EXTERNAL_DEPOSIT"
data
Object
An object containing details of the transaction.
{...}
data.statementId
String
Unique identifier for the statement.
"acs_01k74gx1qsdkaycpqvk87v4fg6"
data.debtorDocument
String
The CPF/CNPJ of the debtor
"12345678910"
data.debtorName
String
Full name of the debtor
"John Doe"
data.amount
Integer
The transaction amount in cents (e.g., 100 = R$1.00).
100
data.debtorAccount
Object
An object with the debtor's bank account details.
{...}
data.debtorAccount.bank
String
Name of the sender's financial institution.
"BANK NAME"
data.debtorAccount.branch
String
The debtor's bank branch number.
"0001"
data.debtorAccount.number
String
The debtor's bank account number.
"123456678"

