Skip to content

Deel: Retrieve a payment statement

Deel payments.getPaymentStatement: arguments, response, policy and SDK examples.

← Payments operations · Get started

Operation deel.payments_getpaymentstatement_v2026_07_23

Provider route: GET /payments/statements/{payment_statement_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["payments"]["getPaymentStatement"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.payments.getPaymentStatement(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.payments.get_payment_statement(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.payment_statement_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a payment statement — 201 response body

Referenced models: Retrieve a payment statement — 201 response body

1 more schema is linked from the tables above, on the schema pages.

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 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.
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.

SDK function policy ID: deel.payments_getpaymentstatement_v2026_07_23. Catalog operation: payments_getpaymentstatement_v2026_07_23. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["payment-statements:read"]

Pinned headers: {"X-Version": "2026-07-23"}

Official provider source

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.