API Reference

Create a currency exchange

post
https://platform-api.sandbox.testessential.net/wallet/direct-exchange

Create a request to exchange one currency for another on the user's account.DryRun request parameter allows to simulate an operation without actually executing or persisting any changes.

Query Params
boolean

if true, the API simulates the operation without executing it. This allows you to preview exchange rates, fees, and other details before committing. The actual exchange will only proceed if dryRun is omitted or explicitly set to false.

Body Params
uuid

unique identifier for the direct exchange

string
required

account initiating the exchange.

string

destination account for the exchange.

string
required

currency being exchanged from.

string
required

currency being exchanged to.

string

amount in the source currency.

string

amount in the target currency.

signedRate
object

rate at which the exchange is executed.

string

status of the direct exchange.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 5 months ago