Swap Currencies

Body Params
string
required

The Id of the user who is sending this transaction

string
required

The Id of the account to debit

string
required

The Id of the account to credit

string

An optional memo

string
required

The amount denominated in the smallest divisible unit of the sending currency. For example: cents or satoshis

boolean

The simulateFailure key is a boolean value that, when set to true, instructs the API to simulate a failed case. This feature is only available in a sandbox environment

string
required

IP address collected as the IP address from which the End User is making the swap request. IMPORTANT - This will be a required parameter from the 15th of June 2023 and is optional until then.

string

Optional fixedFee in Euro cents to override the default application fee configuration. This amount can only be <= the default configured amount for this transaction type.

string

Optional percentage fee in bps to override the default application fee configuration. This amount can only be <= the default configured amount for this transaction type.

string

The proposed swap rate must be within 3% above or below the current market rate and can have a maximum of 6 decimal places.

Headers
string
required

api-key is available on the dashboard

string
required
Response

Language
Credentials
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json