StatusLog In
API Reference and Guides

Sections

Theme switcher

/trades/{tradeTransactionId}

Header Parameters

Authorizationstring

Path Parameters

tradeTransactionIdstring Required
Min length
38
Max length
100
Pattern
[a-zA-Z]{1,63}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Response

200
Object
Successful response.

Response Attributes

OneOf 

tradeTransactionIdstring

ID of the trade transaction itself.

Min length
38
Max length
100
Pattern
tradeTransaction_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
readOnly
buyCurrencystring

3-letter Currency of the currency being bought.

Min length
3
Max length
3
sellCurrencystring

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.

sellAmountnumber

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

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}
ratenumber

Actual rate the trade was booked at.

readOnly
statusstring

The status of the trade transaction.

Enum values:
submittedprocessingpending_settlementpending_payment_processingawaiting_fundssettledrejected
readOnly
fromWalletIdstring

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}
tenorstring

The tenor of the trade.

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

The UTC datetime for when the trade will settle.

createdAtstring

The UTC datetime for when the trade was created.

Min length
20
Max length
20
readOnly
updatedAtstring

The UTC datetime for when the trade was last updated.

Min length
20
Max length
20
readOnly
externalReferencestring

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

paymentTransactionIdstring

The Id of the payment transaction.

Min length
38
Max length
100
Pattern
paymentTransaction_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
readOnly
400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

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?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?