Request a bank transfer

Requests a payout from your Trading balance to an existing beneficiary belonging to your account. Currency comes from the beneficiary; do not send currency in the body. Requires the WITHDRAWAL permission where user policies apply, a signed current contract, an eligible beneficiary and sufficient withdrawable balance for the amount plus fee. The request requires an integer amount of at least 1000 in the beneficiary currency’s main units. Further provider/account limits apply. If approval is required, HTTP 202 returns an approval request. A reused approval key can return an existing request with its current status; the response is not proof that a payout has completed. HTTP 201 returns the transfer record, usually Pending or Awaiting, and does not mean the recipient has been paid. Use the transferID to check GET /bank-transfer/{transferId}. Reuse of uid is checked for duplicate transfers, but automatic retries after an uncertain outcome are not guaranteed safe; check the existing transfer first.

Body Params
uuid
required

Existing beneficiary ID.

integer
required
≥ 1000

Integer amount in main currency units.

string
Defaults to N/A

Transfer description.

string

Optional caller reference checked for duplicate transfer creation.

Headers
string
length ≤ 200

Optional approval-workflow key, at most 200 characters. Protects the approval request only; it is not general payout idempotency.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json