Axiym

Transfer client balance to your account

Moves funds from the client's settlement balance to your own settlement account for the same currency and payment rail. Use it to return an overpayment or funds received in error: once on your account, withdraw them with the Account API. This is an instant book transfer; no bank movement occurs. Funds already applied to a receivable are not returned by this operation.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID).

Formatuuid

Header Parameters

X-Request-Id?string

Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the X-Request-Id response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.

Formatuuid
Idempotency-Key?string

Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.

Lengthlength <= 255

Request Body

application/json

amount*string

Amount to move from the client's settlement balance. Cannot exceed the client's balance.

currency*Currency

Currency code — ISO 4217 fiat (e.g. USD, EUR) or a supported stablecoin (USDT, USDC).

paymentRails?string

Payment rail code of the client's settlement balance.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json