Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Stablecoin Conversion

Create Stablecoin Conversion

Create a Conversion request to exchange assets 1:1.

A request to create a conversion can fail with one of the following types of errors:

  • Insufficient Funds if the Profile (profile_id) has insufficient available balance to fund the execution.
  • Already Exists if a conversion with the same external ID (ref_id) has already been created.
post/conversion/stablecoins

Request body

profile_idstring required

The Profile associated with a conversion.

amountstring required

Asset amount to convert. Details.

source_assetstring required

The asset to convert from. Details.

target_assetstring required

The asset to convert to. Details.

ref_idstring

Client provided, unique Reference ID for lookup and replay protection.

identity_idstring

The Identity ID associated with the user requesting the conversion. Required only for customers with 3rd-Party integrations.

account_idstring

The Account ID associated with the user requesting the conversion. Required only for customers with 3rd-Party integrations.

metadataobject

Optional client-specified stored metadata.

recipient_profile_idstring

For directed settlement, the receiving side profile_id.

Response

A successful response.

idstring

System provided UUID for the conversion is provided in the Create Stablecoin Conversion response.

Required parameter for the Get Stablecoin Conversion request.

profile_idstring

The Profile associated with a conversion. Required in the Create Stablecoin Conversion request.

amountstring decimal

Asset amount to convert. Details.

source_assetstring

The asset to convert from. Details.

target_assetstring

The asset to convert to. Details.

statusstring

The current status of the conversion. Details.

ref_idstring

Client provided, unique Reference ID included the Create Stablecoin Conversion request.

identity_idstring

The Identity ID associated with the user requesting the conversion. Required only for customers with 3rd-Party integrations.

account_idstring

The Account ID associated with the user requesting the conversion. Required only for customers with 3rd-Party integrations.

created_atstring date-time

The time at which the conversion was requested. See RFC3339 format, like 2006-01-02T15:04:05Z.

updated_atstring date-time

The time at which the conversion was last updated. RFC3339 format, like 2006-01-02T15:04:05Z.

settled_atstring date-time

The time at which the conversion was settled. Details. RFC3339 format, like 2006-01-02T15:04:05Z.

cancelled_atstring date-time

The time at which the conversion has been cancelled. Details. RFC3339 format, like 2006-01-02T15:04:05Z.

metadataobject

Optional client-specified stored metadata.

recipient_profile_idstring

For directed settlement, the receiving side profile_id.