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.

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 Account 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 for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

A conversion along one of your conversion pairs. pairId selects the accounts on both sides; sellAmount is in the pair's sell currency.

pairId*string

Conversion pair identifier from GET /clients/{clientId}/conversion-pairs.

Formatuuid
sellAmount*string

Amount to sell, in the pair's sell currency.

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