StatusLog In
API Reference and Guides

Sections

Theme switcher

/trades

Header Parameters

idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring

Body Parameters

buyCurrencystring Required

3-letter Currency of the currency being bought.

Min length
3
Max length
3
sellCurrencystring Required

3-letter Currency of the currency being sold.

Min length
3
Max length
3
buyAmountnumber

How much the account owner will receive in the buy currency.

Minimum
1
sellAmountnumber

How much is owed by the account owner in order to fund the trade.

Minimum
1
rateSheetIdstring

The ID of the Ratesheet used to generate the trades rate.

Min length
38
Max length
100
Pattern
rateSheet_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
quoteIdstring

The ID of the Quote used to generate the trades rate.

Min length
38
Max length
100
Pattern
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
fromWalletIdstring Required

The ID of the wallet which will supply the sell currency.

Min length
38
Max length
100
Pattern
wallet_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
toWalletIdstring

The ID of the wallet which if specified the buy currency will fall into.

Min length
38
Max length
100
Pattern
wallet_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
requestedTenorstring

The preferred tenor for the trade. This will be confirmed in the response.

Enum values:
T+0T+1T+2
externalReferencestring

An optional value that can be passed in to later reference a related resource in the partner system.

paymentobject

Show child attributes

Response

201
Object
Successful response.

Response Attributes

itemobject

Show child attributes

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

409
Object
Conflict

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?