API ReferenceCustomersAPI IntegrationConversions

Get a Conversion

Retrieve details of a previously requested currency conversion. This endpoint returns comprehensive information about a specific conversion, including conversion rates, amounts, booking dates, value dates, conversion status, and any client reference ID that was provided during the conversion request. **Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired
Unique Customer Identifier
conversion_idstringRequired

Unique Conversion ID, provided in the original request for a Conversion. This is the conversion_id that was provided in the response when the conversion was requested via the Request Conversion API.

Response

Ok. Successfully requested details of a Conversion.
conversion_idstring
ID of this currency exchange for future reference. Use this ID to check the status of the conversion or retrieve conversion details.
instruction_numberstring

Unique client reference to identify this conversion in future. The format will be {customerId}-{sequenceNumber}.

This instruction number can be used to track and reference the conversion in your system.

selling_currencystring

ISO Code for the currency being sold. This is the source currency you are exchanging from.

Format: 3-letter ISO 4217 currency code (e.g., GBP, USD, EUR)

buying_currencystring

ISO Code for the currency being bought. This is the destination currency you are exchanging to.

Format: 3-letter ISO 4217 currency code (e.g., GBP, USD, EUR)

selling_amountdouble

Amount of the currency being sold. This represents the source currency amount that will be exchanged.

Format: Decimal number with up to 2 decimal places Precision: Maximum 2 decimal places

buying_amountdouble

Amount of the currency being bought. This represents the destination currency amount you will receive.

Format: Decimal number with up to 2 decimal places Precision: Maximum 2 decimal places

agreed_ratedouble

Exchange rate agreed upon for this conversion. This rate determines how much of the buying currency will be received for each unit of the selling currency.

Calculation: buying_amount = selling_amount × agreed_rate

Note: This rate is locked in at the time of booking and will be used for the conversion execution.

booking_datetimedatetime

Timestamp of this request/deal. This is the date and time when the conversion was booked and the exchange rate was locked in.

Format: ISO 8601 date-time format (YYYY-MM-DDTHH:MM:SSZ)

statusenum

Status of this conversion transaction. The status indicates the current state of the conversion.

Possible values include:

  • OPEN - This implies that the conversion is not executed/settled.
  • CLOSED - Conversion has been fully settled or closed
Allowed values:
value_datedate

This is the estimated date for the delivery of the funds into your wallet or (if making an outbound Payment) the Recipient’s Bank Account. It is dependent upon a few conditions, such as:

  • The time of day of the request
  • Whether there is sufficient cleared funds in your account
  • The currency
  • The payment processing route to the bank account

Format: ISO 8601 date format (YYYY-MM-DD)

client_reference_idstring

Unique reference ID that you assigned to this conversion for your own purposes. This is the optional client_reference_id query parameter that was provided when the conversion was requested via the Request Conversion endpoint.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error