Axiym

Create withdrawal

Creates a withdrawal from the selected client's Axiym account to a whitelisted external bank account or wallet.

Requirements

  • sourceAccountId must identify an Axiym account belonging to the selected client.
  • destinationId must identify an external account registered in the selected client's address book.
  • The source Axiym account and the external account must both be ACTIVE and use the same currency.

The response includes the withdrawal, source account, and destination details and has status PENDING_CONFIRMATION. Creation does not begin execution; confirm the returned withdrawalId with POST /clients/{clientId}/withdrawals/{withdrawalId}/confirm.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Client Account API resources. The client must belong to your partnership; anyone else's id returns 404.

Formatuuid

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid
Idempotency-Key*string

A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

A withdrawal from the selected client's Axiym account to a whitelisted external account identified by destinationId in that client's address book. Both accounts must be ACTIVE and use the same currency. Creating the withdrawal returns PENDING_CONFIRMATION; call POST /clients/{clientId}/withdrawals/{withdrawalId}/confirm to begin execution.

sourceAccountId*string

Source account identifier (UUID).

Formatuuid
sourceAmount*object

Amount to debit from the source account. Its currency must be the source account currency.

destinationId*string

Identifier of the whitelisted external account in the selected client's address book. It must be ACTIVE and use the source Axiym account's currency.

Formatuuid
reference?string

Text shown to the recipient, typically the invoice number.

Lengthlength <= 140
supportingDocuments?array<SupportingDocumentInput>

Documents supporting the payment, such as an invoice. Required where the destination corridor requires evidence.

Itemsitems <= 10
externalReference?ExternalReference

Your reference for correlation, echoed back on related objects.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json