Create a withdrawal

post

https://api.uat.paymentology.com/pty/account/v1/withdrawals

Creates a withdrawal (cash-out) operation. Single-currency only.
Business-rule rejections (for example, insufficient funds) are returned as 201 with status REJECTED and failure_reason populated, not as a 4xx error.

Body Params

Withdrawal (cash-out) request. Single-currency only — source_amount describes the debit
applied to the internal source account; both amount and currency are required.
The external_account_reference identifies the external destination.

source_account_id

string

required

length between 1 and 50

Internal source account identifier

external_account_reference

string | null

External destination account reference

source_amount

object

required

A monetary amount with currency. amount is in minor units (positive integer string).

On a transfer request, both source_amount and destination_amount are present and each
carries its currency. Exactly one must supply amount — the server computes the other
and populates both on the stored record.
On a deposit request (destination_amount) and a withdrawal request (source_amount),
both amount and currency are always required.
On every response (Create or Get), all Money objects are fully populated (amount + currency).

fee

object

Fee on a withdrawal. Always charged to the source account:
the source is debited source_amount.amount + fee.amount.
fee.currency must equal source_amount.currency.

transaction_reference

string

required

length between 1 and 100

^\S+$

Client-provided unique transaction reference (idempotency key). Must not
contain whitespace.

transaction_description

string

length between 1 and 255

Human-readable description

Responses

403

Access token rejected by the API gateway (for example, expired).

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Withdrawal created

400Request rejected before processing. VALIDATION_ERROR for field-level errors (listed in details); otherwise a business-rule code: ACCOUNT_NOT_ACTIVE, CURRENCY_MISMATCH, INVALID_AMOUNT, INVALID_CURRENCY, FEE_EXCEEDS_AMOUNT, FEE_CURRENCY_MISMATCH.

401Missing or invalid access token: UNAUTHORIZED, INVALID_CLIENT or INVALID_TENANT.

404ACCOUNT_NOT_FOUND: an account in the request does not exist or does not belong to the client.

409IDEMPOTENCY_CONFLICT: the transaction_reference was already used for a withdrawal with a different request body. Resending the identical request returns the original withdrawal with 201.

424DEPENDENCY_FAILURE: the ledger could not process the withdrawal. It was not completed and can be retried with the same transaction_reference.

500INTERNAL_SERVER_ERROR: unexpected error.

503SERVICE_UNAVAILABLE or INFRASTRUCTURE_ERROR: temporary failure. The withdrawal was not completed and can be retried with the same transaction_reference.