Axiym

Create withdrawal

Creates a withdrawal from the selected client's Axiym account to one of the client's registered external accounts. 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.

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 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

TypeScript Definitions

Use the request body type in TypeScript.

A withdrawal from sourceAccountId to a registered external account. amount uses the source account's currency. The destinationId must be ACTIVE and use the same currency.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json