Axiym

Create withdrawal

Creates a withdrawal from the selected client's Axiym account to one of the client's address book entries.

Requirements

  • sourceAccountId and destinationId must belong to the client.
  • Both accounts must be ACTIVE and use the same currency.
  • Partner-owned and third-party external accounts are not allowed.

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 Trade 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 that makes a funds-moving request safe to retry. Reusing the key returns the original result instead of creating a duplicate. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

A withdrawal from sourceAccountId to an address book entry. sourceAmount is debited from the source account in its currency. The destinationId 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 address book entry to pay. It must be ACTIVE and in 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