Skip to main content

Retrieve a specific order by ID

GET 
/api/v1/orders/:orderId

Get details of a specific order by its ID.

Request​

Path Parameters

    orderId stringrequired

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[13-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}

    The unique identifier of the order.

Responses​

Order details.

Schema
    id stringrequired

    The unique identifier of the order.

    status stringrequired

    Possible values: [inProgress, completed, failed]

    The current status of the order. Possible values include: inProgress: The order is currently being processed and has not yet been completed. completed: The payer has completed the order, and the funds have been credited to the merchant's wallet. failed: The client either did not complete the payment within the order's lifetime or did not fully pay the order if it was a payment order.

    createdAt stringrequired

    The timestamp when the order was created, in the ISO 8601 format, including the date, time, and timezone information.

    updatedAt stringrequired

    The timestamp when the order status was last updated, in the ISO 8601 format, including the date, time, and timezone information.

    primaryAmount nullable

    The amount and currency the merchant will receive after deducting the service fee.

    amount stringrequired

    The monetary value, as a decimal number with up to 6 decimal places.

    currency stringrequired

    Possible values: [USDT, TRX]

    The currency of the amount.

    secondaryAmount objectnullable

    The amount and currency of the order in euros.

    amount stringrequired

    The monetary value, as a decimal number with up to 2 decimal places.

    currency stringrequired

    Possible values: [EUR]

    The currency of the amount.

    serviceFeeAmount nullable

    The service fee applied to the order. The currency of the service fee always matches the currency of the primaryAmount.

    amount stringrequired

    The monetary value, as a decimal number with up to 6 decimal places.

    currency stringrequired

    Possible values: [EUR]

    The currency of the amount.

    totalAmount nullable

    The total amount and currency involved in the order, including fees. This is the amount the payer actually paid.

    amount stringrequired

    The monetary value, as a decimal number with up to 6 decimal places.

    currency stringrequired

    Possible values: [USDT, TRX]

    The currency of the amount.

Loading...