Deel: Payments schemas
7 Deel schemas with complete fields and constraints.
← Payments operations · All schemas
Create and pay a payment statement — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
invoice_ids | array | Required within parent | Identifiers of the invoices to include in the payment statement. A maximum of 100 invoices can be paid in one request. |
invoice_ids[] | string | Each item | |
payment | Model | Required within parent | Expand Create and pay a payment statement — request body — body data payment Settlement details for the payment: the push method and the currency, plus the country for a bank transfer (also when method is omitted) or the network for a stablecoin transfer. |
Referenced models: Create and pay a payment statement — request body — body data payment
Create and pay a payment statement — request body — body data payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Settlement details for the payment: the push method and the currency, plus the country for a bank transfer (also when method is omitted) or the network for a stablecoin transfer. |
country | string | Optional | Two-letter country code for the bank transfer method, following ISO 3166-1 alpha-2. Required when method is BANK_TRANSFER or omitted (bank transfer is the default); ignored for STABLECOIN_TRANSFER. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
currency | string | Required within parent | Currency to pay in: a three-letter ISO 4217 code for a bank transfer, or USDC or USDT for a stablecoin transfer. Must match the currency of the created statement. Maximum length: 4 Minimum length: 3 Pattern: ^([A-Z]{3}|USDC|USDT)$ |
method | string | Optional | Push method to pay the statement with. Defaults to BANK_TRANSFER. STABLECOIN_TRANSFER pays in USDC or USDT to a deposit address Deel returns for the organization, currency and network; it must be enabled for the organization. One of: BANK_TRANSFER, STABLECOIN_TRANSFER |
network | string | Optional | Blockchain network to send the stablecoin on. Required for STABLECOIN_TRANSFER and not accepted for other methods. USDC runs on ETHEREUM, BASE, SOLANA and POLYGON; USDT on TRON, ETHEREUM and POLYGON. One of: ETHEREUM, BASE, SOLANA, POLYGON, TRON |
Retrieve a payment statement — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a payment statement — 201 response body — data |
Referenced models: Retrieve a payment statement — 201 response body — data
Retrieve a payment statement — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | string | Alternative | Total amount of the payment statement before any balance is applied. Null until the amount is set. |
amount (anyOf 2) | null | Alternative | Total amount of the payment statement before any balance is applied. Null until the amount is set. |
amount_due | JSON | Required within parent | |
amount_due (anyOf 1) | string | Alternative | Amount still due after any applied balance and fee credits. Null until the amount is set. |
amount_due (anyOf 2) | null | Alternative | Amount still due after any applied balance and fee credits. Null until the amount is set. |
balance_applied | string | Optional | Amount of client balance applied to the payment statement. |
beneficiary_details | JSON | Optional | Where to send the payment: the bank account for bank transfers and Mercury, the deposit address for stablecoin, or the account email for Coinbase and Wise. Null when not yet resolved. |
beneficiary_details (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, deposit address, deposit uri, email, iban, ifsc code, intermediary bank, network, routing number, sort code, swift, wire routing number |
beneficiary_details (anyOf 2) | null | Alternative | |
created_at | string | Optional | Date and time when the payment statement was created, in ISO-8601 format. Format: date-time |
fee_credits_applied | string | Optional | Amount of fee credits applied to the payment statement. |
id | string | Required within parent | Unique identifier of the payment statement. |
invoices | array | Required within parent | Authoritative superset of invoices settled by this payment statement. It always contains the requested invoices and may include additional overdue or required fee invoices that Deel attaches automatically. |
invoices[] | Model | Each item | Expand Retrieve a payment statement — 201 response body — data invoices item |
paid_at | JSON | Optional | |
paid_at (anyOf 1) | string | Alternative | Date and time when the client paid, in ISO-8601 format. For bank transfers this can be set while the status is still processing. Null until payment is captured. Format: date-time |
paid_at (anyOf 2) | null | Alternative | Date and time when the client paid, in ISO-8601 format. For bank transfers this can be set while the status is still processing. Null until payment is captured. Format: date-time |
payment_currency | JSON | Required within parent | |
payment_currency (anyOf 1) | string | Alternative | Currency code of the payment statement: a three-letter ISO 4217 code, or USDC or USDT for stablecoin payments. Null until a payment method is attached. Maximum length: 4 Minimum length: 3 Pattern: ^([A-Z]{3}|USDC|USDT)$ |
payment_currency (anyOf 2) | null | Alternative | Currency code of the payment statement: a three-letter ISO 4217 code, or USDC or USDT for stablecoin payments. Null until a payment method is attached. Maximum length: 4 Minimum length: 3 Pattern: ^([A-Z]{3}|USDC|USDT)$ |
payment_method | JSON | Optional | Method used to settle the payment statement. OTHER covers methods the API does not expose, such as card and direct debit. Null until a payment method is attached. |
payment_method (anyOf 1) | string | Alternative | Method used to settle the payment statement. OTHER covers methods the API does not expose, such as card and direct debit. Null until a payment method is attached. Known values: BANK_TRANSFER, STABLECOIN_TRANSFER, COINBASE, WISE, MERCURY, OTHER |
payment_method (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Reference to use when reconciling this payment statement against incoming wires. |
reference (anyOf 2) | null | Alternative | Reference to use when reconciling this payment statement against incoming wires. |
status | string | Required within parent | Normalized status of the payment statement. 'PROCESSING' covers any in-flight state (pending, preprocessing, awaiting payment); 'paid', 'cancelled' and 'failed' are terminal. Known values: PROCESSING, PAID, CANCELLED, FAILED |
Referenced models: 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, deposit address, deposit uri, email, iban, ifsc code, intermediary bank, network, routing number, sort code, swift, wire routing number, Retrieve a payment statement — 201 response body — data invoices item
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, deposit address, deposit uri, email, iban, ifsc code, intermediary bank, network, routing number, sort code, swift, wire routing number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where to send the payment: the bank account for bank transfers and Mercury, the deposit address for stablecoin, or the account email for Coinbase and Wise. 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 | Currency code of the beneficiary account: a three-letter ISO 4217 code, or USDC or USDT for stablecoin. Null when not modeled on the rail. Maximum length: 4 Minimum length: 3 Pattern: ^([A-Z]{3}|USDC|USDT)$ |
currency (anyOf 2) | null | Alternative | Currency code of the beneficiary account: a three-letter ISO 4217 code, or USDC or USDT for stablecoin. Null when not modeled on the rail. Maximum length: 4 Minimum length: 3 Pattern: ^([A-Z]{3}|USDC|USDT)$ |
deposit_address | JSON | Optional | |
deposit_address (anyOf 1) | string | Alternative | Deposit address to send the stablecoin to, unique to the organization, currency and network. Null unless the payment method is STABLECOIN_TRANSFER. |
deposit_address (anyOf 2) | null | Alternative | Deposit address to send the stablecoin to, unique to the organization, currency and network. Null unless the payment method is STABLECOIN_TRANSFER. |
deposit_uri | JSON | Optional | |
deposit_uri (anyOf 1) | string | Alternative | Payment URI for the deposit address, suitable for a wallet link or QR code. Null unless the payment method is STABLECOIN_TRANSFER. |
deposit_uri (anyOf 2) | null | Alternative | Payment URI for the deposit address, suitable for a wallet link or QR code. Null unless the payment method is STABLECOIN_TRANSFER. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Account email to send the funds to. Null unless the payment method is COINBASE or WISE. |
email (anyOf 2) | null | Alternative | Account email to send the funds to. Null unless the payment method is COINBASE or WISE. |
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, deposit address, deposit uri, email, iban, ifsc code, intermediary bank, network, routing number, sort code, swift, wire routing number intermediary bank bank name, swift |
intermediary_bank (anyOf 2) | null | Alternative | |
network | JSON | Optional | |
network (anyOf 1) | string | Alternative | Blockchain network of the stablecoin deposit address, in upper case (for example ETHEREUM, BASE, SOLANA, POLYGON, TRON). Null unless the payment method is STABLECOIN_TRANSFER. |
network (anyOf 2) | null | Alternative | Blockchain network of the stablecoin deposit address, in upper case (for example ETHEREUM, BASE, SOLANA, POLYGON, TRON). Null unless the payment method is STABLECOIN_TRANSFER. |
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. |
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, deposit address, deposit uri, email, iban, ifsc code, intermediary bank, network, routing number, sort code, swift, wire routing number intermediary bank bank name, swift
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Intermediary bank to route the transfer through. Null when the rail has none. |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the intermediary bank. |
bank_name (anyOf 2) | null | Alternative | Name of the intermediary bank. |
swift | JSON | Optional | |
swift (anyOf 1) | string | Alternative | SWIFT/BIC code of the intermediary bank. |
swift (anyOf 2) | null | Alternative | SWIFT/BIC code of the intermediary bank. |
Retrieve a payment statement — 201 response body — data invoices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount of the invoice. |
currency | string | Required within parent | Three-letter currency code of the invoice, following ISO 4217. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
id | string | Required within parent | Unique identifier of the invoice. |
is_auto_added | boolean | Optional | True when Deel automatically attached this invoice (e.g. an overdue or required fee invoice) beyond the requested set. |
label | JSON | Optional | |
label (anyOf 1) | string | Alternative | Descriptive label for the invoice. |
label (anyOf 2) | null | Alternative | Descriptive label for the invoice. |