Axiym

Create withdrawal

Creates an outgoing withdrawal from sourceAccountId to the address book entry selected by destinationId.

Requirements

  • The source account and destination must be ACTIVE.
  • They must use the same currency.
  • destinationId must identify a registered address book entry.

The response contains the resolved source and destination details and has status PENDING_CONFIRMATION. Creation does not begin execution; confirm the returned withdrawalId with POST /withdrawals/{withdrawalId}/confirm.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional client-generated request identifier (UUID recommended) for end-to-end tracing.

Axiym echoes it in the X-Request-Id response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.

Formatuuid
Idempotency-Key*string

Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.

Repeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.

Lengthlength <= 255

Request Body

application/json

An outgoing payment from sourceAccountId to destinationId. sourceAmount is debited from the source account in its currency.

The destination must be an ACTIVE address book entry in the same currency. Creation returns a withdrawal awaiting confirmation; it does not 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