Sign in
latestOpenAPI 3.0.32026-08-106722.8 KB

7579ec027be7

Orders

Get order by id

Returns order details for the given order id.

get/v1/orders/{id}

Path parameters

idstring uuid required

Unique identifier of the order.

Response

Order details.

orderIdstring uuid required

Unique identifier of the order.

externalReferencestring

External order reference set by the partner. Limited to 100 characters.

subPartnerIdstring

Optional third-party reference set by the partner. Limited to 50 characters.

orderType'BUY' | 'SELL' required

Order direction. BUY for on-ramp, SELL for off-ramp.

createdAtstring date-time required

Timestamp when the order was created.

orderState'PENDING' | 'WITHDRAWING' | 'COMPLETED' | 'FAILED' required

Current state of the order.

orderStateUpdatedAtstring date-time required

Timestamp of the last order state change.

paymentMethod'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'BANK_TRANSFER_NIP' required

Payment method to be used for the order.

inputCurrencystring required

Fiat currency used to fund the order.

inputAmountstring required

Fiat amount used to fund the order.

outputCurrencystring required

Crypto currency purchased.

outputAmountstring required

Amount of crypto received.

amountUsdstring required

Transaction value in USD. Approximate when inputCurrency is not USD.

processingFeestring required

Blockchain.com Pay processing fee denominated in inputCurrency.

processingFeeUsdstring required

Blockchain.com Pay processing fee in USD. Approximate when inputCurrency is not USD.

partnerFeestring required

Partner fee denominated in inputCurrency.

partnerFeeUsdstring required

Partner fee in USD. Approximate when inputCurrency is not USD.

networkFeestring required

Blockchain network fee denominated in inputCurrency.

networkFeeUsdstring required

Blockchain network fee in USD. Approximate when inputCurrency is not USD.

userIdstring uuid required

Unique identifier of the user who placed the order.

targetWalletAddressstring required

Crypto wallet address that received the output currency.

transactionHashstring

Blockchain transaction hash. Only present for COMPLETED orders.

Example response

{
  "orderId": "f41a3e45-6392-457c-8566-a282b5f3e177",
  "externalReference": "your_order_id",
  "subPartnerId": "your_sub_partner_id",
  "orderType": "BUY",
  "createdAt": "2024-10-01T12:00:00Z",
  "orderState": "COMPLETED",
  "orderStateUpdatedAt": "2024-10-01T13:00:00Z",
  "paymentMethod": "CARD",
  "inputCurrency": "USD",
  "inputAmount": "100.00",
  "outputCurrency": "BTC",
  "outputAmount": "0.001",
  "amountUsd": "100.00",
  "processingFee": "1.00",
  "processingFeeUsd": "1.00",
  "partnerFee": "0.50",
  "partnerFeeUsd": "0.50",
  "networkFee": "1.50",
  "networkFeeUsd": "1.50",
  "userId": "2b6f0cc9-7b0c-4f3b-8f3b-6f0cc97b0c4f",
  "targetWalletAddress": "bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu",
  "transactionHash": "4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80"
}