withdrawal
Withdrawal webhook payloads by status
Bitso delivers a withdrawal event when a withdrawal from your account changes status. details varies by currency and network.
Use the tabs to switch the example by payload.status.
{
"event": "withdrawal",
"payload": {
"wid": "91a72aed1b289f9314275c06c40ec317",
"status": "pending",
"created_at": "2024-07-09T21:19:23+00:00",
"currency": "brl",
"method": "pixstark",
"method_name": "Pix",
"amount": "3000",
"asset": "brl",
"network": "pix",
"protocol": "pix_ind",
"integration": "stark",
"details": {
"end_to_end_id": "D3513612020240709211800000005249",
"payee": {
"account_number": "Payee's account ID",
"bank_code": "Bank code for the payee's account",
"tax_id": "Payee's taxpayer ID number",
"name": "Payee's name",
"bank_name": "Payee's bank name"
},
"payer": {
"account_number": "Payer's account ID",
"tax_id": "Payer's taxpayer ID number",
"name": "Payer's name",
"bank_name": "Payer's bank name"
},
"is_reversal": false
}
}
}{
"event": "withdrawal",
"payload": {
"wid": "91a72aed1b289f9314275c06c40ec317",
"status": "complete",
"created_at": "2024-07-09T21:19:23+00:00",
"currency": "brl",
"method": "pixstark",
"method_name": "Pix",
"amount": "3000",
"asset": "brl",
"network": "pix",
"protocol": "pix_ind",
"integration": "stark",
"details": {
"end_to_end_id": "D3513612020240709211800000005249",
"payee": {
"account_number": "Payee's account ID",
"bank_code": "Bank code for the payee's account",
"tax_id": "Payee's taxpayer ID number",
"name": "Payee's name",
"bank_name": "Payee's bank name"
},
"payer": {
"account_number": "Payer's account ID",
"tax_id": "Payer's taxpayer ID number",
"name": "Payer's name",
"bank_name": "Payer's bank name"
},
"is_reversal": false
}
}
}{
"event": "withdrawal",
"payload": {
"wid": "91a72aed1b289f9314275c06c40ec317",
"status": "failed",
"created_at": "2024-07-09T21:19:23+00:00",
"currency": "brl",
"method": "pixstark",
"method_name": "Pix",
"amount": "3000",
"asset": "brl",
"network": "pix",
"protocol": "pix_ind",
"integration": "stark",
"details": {
"end_to_end_id": "D3513612020240709211800000005249",
"payee": {
"account_number": "Payee's account ID",
"bank_code": "Bank code for the payee's account",
"tax_id": "Payee's taxpayer ID number",
"name": "Payee's name",
"bank_name": "Payee's bank name"
},
"payer": {
"account_number": "Payer's account ID",
"tax_id": "Payer's taxpayer ID number",
"name": "Payer's name",
"bank_name": "Payer's bank name"
},
"is_reversal": false
}
}
}Statuses are lowercase (pending, complete, failed).
Updated 2 months ago
Did this page help you?
