Axiym

Create conversion

Creates a conversion quote. Provide a permitted pairId and the amount to sell. The pair determines the 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

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

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 /conversion-pairs.

Formatuuid
sellAmount*object

Amount to sell. Its currency must be the sell currency of the pair.

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