FIfinmo
FX-Conversion

New FX-Conversion

Changed on

Convert money from one currency to another using spot FX rates and, upon success the API will return the details of the completed conversion.

If you have an FX rate (fx_rate_id) obtained previously from the Get FX Rate API, you can use it for the conversion. If no fx_rate_id is provided, the platform will use the live rate for the conversion.

Most conversions are completed within 2 minutes or less. However, since Finmo uses live rates, conversions may not occur instantly on non-trading days. In such cases, Finmo will send an FX_CONVERSION_COMPLETE webhook notification once the conversion is completed.

Currently, Finmo does not support the cancellation of FX-Conversions. The platform operates on a good funds model, always checking the balance in the source currency before proceeding. Cancellation could result in a loss due to fluctuating spot rates.

post/fx-conversion

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Headers

x-envstring required
Example:production

Request body

source_currencystring required

Source (sending) currency code. It has to be a valid ISO 4217 currency code.

target_currencystring required

Target (receiving) currency code. It has to be a valid ISO 4217 currency code.

source_amountnumber nullable required

Conditionally required: Either source_amount or target_amount is required, never both. Amount in source currency.

target_amountnumber nullable required

Conditionally required: Either source_amount or target_amount is required, never both. Amount in target currency.

fx_rate_idstring

FX Rate ID received in Get FX Rates API response.

organization_reference_idstring

A reference you can later use to identify this payment, such as an order number. Can only be alphanumeric and must be unique for Benefit.

webhook_urlstring

Custom webhook url. If it is not provided, webhook will be triggered to the endpoint configured in the Dashboard.

metadataobject

Custom Data

Example request

{
  "fx_rate_id": "fx_rate_87fbf1bcb9bd440fa53572a685bbaaf3",
  "metadata": {},
  "organization_reference_id": "org_cabaa0025a114601abeee3a778141493",
  "source_amount": null,
  "source_currency": "AUD",
  "target_amount": 100,
  "target_currency": "USD",
  "webhook_url": "https://finmo.net"
}

Response

Created

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Changes