API Reference

Create order

post
https://api.gravv.xyz/v1/fx/orders

Creates an OTC order. The order is created in waiting_approval and doesn't execute until a second user approves it.

A market order executes at the current rate once approved. A limit order waits until the rate reaches target_rate, then executes once approved.

Set destination_type to control where the converted funds settle: an internal account, a crypto wallet, or a saved settlement instruction (ssi).

The Idempotency-Key header is required; requests without it are rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

ID of the customer the order is created for.

string
enum
required

A market order executes at the current rate once approved. A limit order waits until the rate reaches target_rate, then executes once approved.

Allowed:
pair
object
required
string
required

Amount of the base currency to exchange. Must be greater than zero.

string

Required for limit orders. The rate at which the order should execute.

string
enum
Defaults to sell

Side of the order. Defaults to sell.

Allowed:
string
enum

Where the funds come from. Fiat base currencies are funded from an account; crypto base currencies from a wallet.

Allowed:
string

ID of the source account or wallet.

string
enum

Where the proceeds settle. Use ssi to settle to a saved settlement instruction.

Allowed:
string

ID of the destination account, wallet, or settlement instruction.

Headers
string
required

A unique key to prevent duplicate requests. Required on all FX write operations; requests without it are rejected with a 400.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?