Deel: Retrieve a payment statement — 201 response body — data
Retrieve a payment statement: 201 response body, field data. 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
| 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 | Beneficiary bank details the payment is settled to. 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, iban, ifsc code, intermediary bank, 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 | Three-letter currency code of the payment statement, following ISO 4217. Null until a payment method is attached. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
payment_currency (anyOf 2) | null | Alternative | Three-letter currency code of the payment statement, following ISO 4217. Null until a payment method is attached. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
payment_method | JSON | Optional | |
payment_method (anyOf 1) | string | Alternative | Method used to settle the payment statement. Null until a payment method is attached. |
payment_method (anyOf 2) | null | Alternative | Method used to settle the payment statement. Null until a payment method is attached. |
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, iban, ifsc code, intermediary bank, routing number, sort code, swift, wire routing number, Retrieve a payment statement — 201 response body — data invoices item