Skip to main content

Lookup an exchange by ID

GET 
/api/v1/orders/exchange/:id

Lookup an exchange by ID

Request​

Path Parameters

    id stringrequired

    Unique identifier of the exchange

    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Header Parameters

    ApiKey stringrequired
    AccountId stringrequired

Responses​

OK

Schema
    id uuidrequired

    Unique ID of the exchange

    shortId stringrequired

    Short ID of the exchange

    externalId stringrequired

    External ID of the exchange

    rate objectrequired

    Rate of the exchange

    price numberrequired
    currencyPair stringrequired
    type stringrequired

    Possible values: [BID, OFFER]

    from objectrequired
    amount numberrequired

    The specific monetary value that is being converted from in the currency exchange

    currency stringrequired

    Possible values: Value must match regular expression [A-Z]{3}

    The type of currency that the money is being exchanged from

    to objectrequired
    amount numberrequired

    The specific monetary value that is being converted from in the currency exchange

    currency stringrequired

    Possible values: Value must match regular expression [A-Z]{3}

    The type of currency that the money is being exchanged from

    settlementDate daterequired

    Settlement date of the exchange

    exchangeStatus objectrequired

    Status of the exchange

    state stringrequired

    Possible values: [DRAFT, SUBMITTING, UNKNOWN, SUBMITTED, ORDERED, ORDER_SETTLED, SUCCESS, REJECTED, FAILED, CANCELLED]

    The current state of the exchange process

    reason string

    Possible values: [DRAFT, SUBMITTING, UNKNOWN, SUBMITTED, ORDERED, ORDER_SETTLED, SUCCESS, REJECTED, FAILED, FAILED_BREACHES_LIMIT, CANCELLED]

    Reason for the exchange state

    complete boolean

    Completion status of the exchange

    createdAt date-timerequired

    Creation time of the exchange

    completedAt date-time

    Completion time of the exchange

Loading...