POST/api/v2/banking/orders/trade

POST /api/v2/banking/orders/trade

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
accountId (query)stringNo

Request body

application/json

Request body fields
FieldTypeRequiredDescription
orderIdstringNoOrder ID returned by the quote response. This identifies the provider quote/order to execute. OrderId returned by POST /api/v2/banking/orders/quote.
quoteRequestIdstringNoQuote request ID returned by the quote response. This is different from OrderId and must be sent back with the trade request. QuoteRequestId returned by POST /api/v2/banking/orders/quote. This is separate from OrderId.
moveMoneyRequestIdstringNoOptional move-money request ID. Omit it unless the upstream quote/payment flow returned one. Optional. Omit unless the upstream quote/payment flow returned a moveMoneyRequestId.
paymentsobjectNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
orderIdstringNoOrder ID for the trade
bankstringNoBank identifier
settlementEqualsMoneyTradeSettlementNoSettlement details for trade
tradeEqualsMoneyTradeDetailsNoTrade execution details

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/banking/orders/trade" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.