Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
invoice_idsarrayRequired within parentIdentifiers of the invoices to include in the payment statement. A maximum of 100 invoices can be paid in one request.
invoice_ids[]stringEach item
paymentModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootSettlement 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.
countrystringOptionalTwo-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}$
currencystringRequired within parentCurrency 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)$
methodstringOptionalPush 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
networkstringOptionalBlockchain 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)stringAlternativeTotal amount of the payment statement before any balance is applied. Null until the amount is set.
amount (anyOf 2)nullAlternativeTotal amount of the payment statement before any balance is applied. Null until the amount is set.
amount_dueJSONRequired within parent
amount_due (anyOf 1)stringAlternativeAmount still due after any applied balance and fee credits. Null until the amount is set.
amount_due (anyOf 2)nullAlternativeAmount still due after any applied balance and fee credits. Null until the amount is set.
balance_appliedstringOptionalAmount of client balance applied to the payment statement.
beneficiary_detailsJSONOptionalWhere 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)ModelAlternativeExpand 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)nullAlternative
created_atstringOptionalDate and time when the payment statement was created, in ISO-8601 format.
Format: date-time
fee_credits_appliedstringOptionalAmount of fee credits applied to the payment statement.
idstringRequired within parentUnique identifier of the payment statement.
invoicesarrayRequired within parentAuthoritative 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[]ModelEach itemExpand Retrieve a payment statement — 201 response body — data invoices item
paid_atJSONOptional
paid_at (anyOf 1)stringAlternativeDate 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)nullAlternativeDate 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_currencyJSONRequired within parent
payment_currency (anyOf 1)stringAlternativeCurrency 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)nullAlternativeCurrency 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_methodJSONOptionalMethod 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)stringAlternativeMethod 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)nullAlternative
referenceJSONOptional
reference (anyOf 1)stringAlternativeReference to use when reconciling this payment statement against incoming wires.
reference (anyOf 2)nullAlternativeReference to use when reconciling this payment statement against incoming wires.
statusstringRequired within parentNormalized 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

FieldTypePresenceDescription and constraints
$objectRootWhere 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_holderJSONOptional
account_holder (anyOf 1)stringAlternativeName of the beneficiary account holder. Null when not modeled on the rail.
account_holder (anyOf 2)nullAlternativeName of the beneficiary account holder. Null when not modeled on the rail.
account_numberJSONOptional
account_number (anyOf 1)stringAlternativeBeneficiary account number. Null on IBAN-only rails.
account_number (anyOf 2)nullAlternativeBeneficiary account number. Null on IBAN-only rails.
account_typeJSONOptional
account_type (anyOf 1)stringAlternativeType of the beneficiary account. Null when not applicable.
account_type (anyOf 2)nullAlternativeType of the beneficiary account. Null when not applicable.
ach_routing_numberJSONOptional
ach_routing_number (anyOf 1)stringAlternativeRouting number to use for ACH transfers. Null when not applicable.
ach_routing_number (anyOf 2)nullAlternativeRouting number to use for ACH transfers. Null when not applicable.
addressJSONOptional
address (anyOf 1)stringAlternativeAddress to include on the transfer for this rail. Null when not applicable.
address (anyOf 2)nullAlternativeAddress to include on the transfer for this rail. Null when not applicable.
bank_addressJSONOptional
bank_address (anyOf 1)stringAlternativeAddress of the beneficiary bank. Null when not applicable.
bank_address (anyOf 2)nullAlternativeAddress of the beneficiary bank. Null when not applicable.
bank_codeJSONOptional
bank_code (anyOf 1)stringAlternativeLocal bank code or institution number of the beneficiary bank. Null when not applicable.
bank_code (anyOf 2)nullAlternativeLocal bank code or institution number of the beneficiary bank. Null when not applicable.
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeName of the beneficiary bank.
bank_name (anyOf 2)nullAlternativeName of the beneficiary bank.
branch_codeJSONOptional
branch_code (anyOf 1)stringAlternativeBranch code or transit number of the beneficiary bank. Null when not applicable.
branch_code (anyOf 2)nullAlternativeBranch code or transit number of the beneficiary bank. Null when not applicable.
bsb_codeJSONOptional
bsb_code (anyOf 1)stringAlternativeBSB code of the beneficiary bank, used for AUD transfers. Null when not applicable.
bsb_code (anyOf 2)nullAlternativeBSB code of the beneficiary bank, used for AUD transfers. Null when not applicable.
countryJSONOptional
country (anyOf 1)stringAlternativeTwo-letter country code of the beneficiary. Best-effort; null when not modeled.
country (anyOf 2)nullAlternativeTwo-letter country code of the beneficiary. Best-effort; null when not modeled.
currencyJSONOptional
currency (anyOf 1)stringAlternativeCurrency 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)nullAlternativeCurrency 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_addressJSONOptional
deposit_address (anyOf 1)stringAlternativeDeposit 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)nullAlternativeDeposit address to send the stablecoin to, unique to the organization, currency and network. Null unless the payment method is STABLECOIN_TRANSFER.
deposit_uriJSONOptional
deposit_uri (anyOf 1)stringAlternativePayment 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)nullAlternativePayment URI for the deposit address, suitable for a wallet link or QR code. Null unless the payment method is STABLECOIN_TRANSFER.
emailJSONOptional
email (anyOf 1)stringAlternativeAccount email to send the funds to. Null unless the payment method is COINBASE or WISE.
email (anyOf 2)nullAlternativeAccount email to send the funds to. Null unless the payment method is COINBASE or WISE.
ibanJSONOptional
iban (anyOf 1)stringAlternativeIBAN of the beneficiary account. Null on non-IBAN rails.
iban (anyOf 2)nullAlternativeIBAN of the beneficiary account. Null on non-IBAN rails.
ifsc_codeJSONOptional
ifsc_code (anyOf 1)stringAlternativeIFSC code of the beneficiary bank, used for INR transfers. Null when not applicable.
ifsc_code (anyOf 2)nullAlternativeIFSC code of the beneficiary bank, used for INR transfers. Null when not applicable.
intermediary_bankJSONOptionalIntermediary bank to route the transfer through. Null when the rail has none.
intermediary_bank (anyOf 1)ModelAlternativeExpand 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)nullAlternative
networkJSONOptional
network (anyOf 1)stringAlternativeBlockchain 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)nullAlternativeBlockchain 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_numberJSONOptional
routing_number (anyOf 1)stringAlternativeRouting number of the beneficiary bank when the rail uses one number for both ACH and wire. Null when not applicable.
routing_number (anyOf 2)nullAlternativeRouting number of the beneficiary bank when the rail uses one number for both ACH and wire. Null when not applicable.
sort_codeJSONOptional
sort_code (anyOf 1)stringAlternativeSort code of the beneficiary bank. Best-effort; null on most rails.
sort_code (anyOf 2)nullAlternativeSort code of the beneficiary bank. Best-effort; null on most rails.
swiftJSONOptional
swift (anyOf 1)stringAlternativeSWIFT/BIC code of the beneficiary bank. Null when not applicable.
swift (anyOf 2)nullAlternativeSWIFT/BIC code of the beneficiary bank. Null when not applicable.
wire_routing_numberJSONOptional
wire_routing_number (anyOf 1)stringAlternativeRouting number to use for wire transfers. Null when not applicable.
wire_routing_number (anyOf 2)nullAlternativeRouting number to use for wire transfers. Null when not applicable.

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 intermediary bank bank name, swift

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

FieldTypePresenceDescription and constraints
$objectRootIntermediary bank to route the transfer through. Null when the rail has none.
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeName of the intermediary bank.
bank_name (anyOf 2)nullAlternativeName of the intermediary bank.
swiftJSONOptional
swift (anyOf 1)stringAlternativeSWIFT/BIC code of the intermediary bank.
swift (anyOf 2)nullAlternativeSWIFT/BIC code of the intermediary bank.

Retrieve a payment statement — 201 response body — data invoices item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount of the invoice.
currencystringRequired within parentThree-letter currency code of the invoice, following ISO 4217.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
idstringRequired within parentUnique identifier of the invoice.
is_auto_addedbooleanOptionalTrue when Deel automatically attached this invoice (e.g. an overdue or required fee invoice) beyond the requested set.
labelJSONOptional
label (anyOf 1)stringAlternativeDescriptive label for the invoice.
label (anyOf 2)nullAlternativeDescriptive label for the invoice.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.