Deel: Retrieve a payment statement — 201 response body — data beneficiary details account holder, account number, account type, ach routing number, address, bank address, bank code, bank name, branch code, bsb code, country, currency, iban, ifsc code, intermediary bank, routing number, sort code, swift, wire routing number
Retrieve a payment statement: 201 response body, field data / beneficiary_details / account_holder, account_number, account_type, ach_routing_number, address, bank_address, bank_code, bank_name, branch_code, bsb_code, country, currency, iban, ifsc_code, intermediary_bank, routing_number, sort_code, swift, wire_routing_number. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve a payment statement — 201 response body — data beneficiary details account holder, account number, account type, ach routing number, address, bank address, bank code, bank name, branch code, bsb code, country, currency, iban, ifsc code, intermediary bank, routing number, sort code, swift, wire routing number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Beneficiary bank details the payment is settled to. Null when not yet resolved. |
account_holder | JSON | Optional | |
account_holder (anyOf 1) | string | Alternative | Name of the beneficiary account holder. Null when not modeled on the rail. |
account_holder (anyOf 2) | null | Alternative | Name of the beneficiary account holder. Null when not modeled on the rail. |
account_number | JSON | Optional | |
account_number (anyOf 1) | string | Alternative | Beneficiary account number. Null on IBAN-only rails. |
account_number (anyOf 2) | null | Alternative | Beneficiary account number. Null on IBAN-only rails. |
account_type | JSON | Optional | |
account_type (anyOf 1) | string | Alternative | Type of the beneficiary account. Null when not applicable. |
account_type (anyOf 2) | null | Alternative | Type of the beneficiary account. Null when not applicable. |
ach_routing_number | JSON | Optional | |
ach_routing_number (anyOf 1) | string | Alternative | Routing number to use for ACH transfers. Null when not applicable. |
ach_routing_number (anyOf 2) | null | Alternative | Routing number to use for ACH transfers. Null when not applicable. |
address | JSON | Optional | |
address (anyOf 1) | string | Alternative | Address to include on the transfer for this rail. Null when not applicable. |
address (anyOf 2) | null | Alternative | Address to include on the transfer for this rail. Null when not applicable. |
bank_address | JSON | Optional | |
bank_address (anyOf 1) | string | Alternative | Address of the beneficiary bank. Null when not applicable. |
bank_address (anyOf 2) | null | Alternative | Address of the beneficiary bank. Null when not applicable. |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | Local bank code or institution number of the beneficiary bank. Null when not applicable. |
bank_code (anyOf 2) | null | Alternative | Local bank code or institution number of the beneficiary bank. Null when not applicable. |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the beneficiary bank. |
bank_name (anyOf 2) | null | Alternative | Name of the beneficiary bank. |
branch_code | JSON | Optional | |
branch_code (anyOf 1) | string | Alternative | Branch code or transit number of the beneficiary bank. Null when not applicable. |
branch_code (anyOf 2) | null | Alternative | Branch code or transit number of the beneficiary bank. Null when not applicable. |
bsb_code | JSON | Optional | |
bsb_code (anyOf 1) | string | Alternative | BSB code of the beneficiary bank, used for AUD transfers. Null when not applicable. |
bsb_code (anyOf 2) | null | Alternative | BSB code of the beneficiary bank, used for AUD transfers. Null when not applicable. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter country code of the beneficiary. Best-effort; null when not modeled. |
country (anyOf 2) | null | Alternative | Two-letter country code of the beneficiary. Best-effort; null when not modeled. |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Three-letter currency code of the beneficiary account, following ISO 4217. Null when not modeled on the rail. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency (anyOf 2) | null | Alternative | Three-letter currency code of the beneficiary account, following ISO 4217. Null when not modeled on the rail. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
iban | JSON | Optional | |
iban (anyOf 1) | string | Alternative | IBAN of the beneficiary account. Null on non-IBAN rails. |
iban (anyOf 2) | null | Alternative | IBAN of the beneficiary account. Null on non-IBAN rails. |
ifsc_code | JSON | Optional | |
ifsc_code (anyOf 1) | string | Alternative | IFSC code of the beneficiary bank, used for INR transfers. Null when not applicable. |
ifsc_code (anyOf 2) | null | Alternative | IFSC code of the beneficiary bank, used for INR transfers. Null when not applicable. |
intermediary_bank | JSON | Optional | Intermediary bank to route the transfer through. Null when the rail has none. |
intermediary_bank (anyOf 1) | Model | Alternative | Expand Retrieve a payment statement — 201 response body — data beneficiary details account holder, account number, account type, ach routing number, address, bank address, bank code, bank name, branch code, bsb code, country, currency, iban, ifsc code, intermediary bank, routing number, sort code, swift, wire routing number intermediary bank bank name, swift |
intermediary_bank (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | Routing number of the beneficiary bank when the rail uses one number for both ACH and wire. Null when not applicable. |
routing_number (anyOf 2) | null | Alternative | Routing number of the beneficiary bank when the rail uses one number for both ACH and wire. Null when not applicable. |
sort_code | JSON | Optional | |
sort_code (anyOf 1) | string | Alternative | Sort code of the beneficiary bank. Best-effort; null on most rails. |
sort_code (anyOf 2) | null | Alternative | Sort code of the beneficiary bank. Best-effort; null on most rails. |
swift | JSON | Optional | |
swift (anyOf 1) | string | Alternative | SWIFT/BIC code of the beneficiary bank. Null when not applicable. |
swift (anyOf 2) | null | Alternative | SWIFT/BIC code of the beneficiary bank. Null when not applicable. |
wire_routing_number | JSON | Optional | |
wire_routing_number (anyOf 1) | string | Alternative | Routing number to use for wire transfers. Null when not applicable. |
wire_routing_number (anyOf 2) | null | Alternative | Routing number to use for wire transfers. Null when not applicable. |