Axiym

Create conversion

Creates a conversion quote for the selected client. Provide a permitted pairId and the amount to sell. The pair determines the client's sell and buy accounts. The response locks the rate and returns the expected buyAmount, fee, and expiry time with status PENDING. Confirm the conversion before it expires to begin execution. An unconfirmed conversion does not execute and cannot be retrieved later.

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 conversion along one of your conversion pairs. pairId selects the accounts on both sides; sellAmount is in the pair's sell currency.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json