Orders

Returns the latest state of user orders

The Orders API allows you to fetch a list of up to 50 recent orders or query for specific ones either by order id or by external reference, set by the partner.

This information can be used to learn order state changes in a passive-polling way. It is an alternative to subscribing to webhooks, which provide automatic and instant updates.

⚠️ Since this API shares sensitive data of the orders, it requires private authentication.

Get orders

get

Returns either:

A list of recent orders, limited to a maximum of 50 orders, sorted by descending creation date.
If externalReference is provided, returns all orders matching that reference.
If walletAddress is provided, returns all orders for that wallet address.

Authorizations

X-Private-API-KeystringRequired

Partner's private API key. Required on order endpoints; indicates a server-to-server call.

Query parameters

limitinteger · max: 50Optional

The number of orders to return. Default and maximum is 50. Ignored when externalReference is provided.

Default: 50Example: 10

offsetintegerOptional

The number of orders to skip. Use together with limit for pagination.

Example: 20

externalReferencestringOptional

External reference of the order(s) set by the partner.

Example: external_order_id

walletAddressstringOptional

User wallet address.

Example: bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu

outputCurrencystringOptional

Filter by output (crypto) currency code.

Example: BTC

fromstring · dateOptional

Start of the date range, inclusive. Format: YYYY-MM-DD.

Example: 2024-10-01

tostring · dateOptional

End of the date range, exclusive. Format: YYYY-MM-DD.

Example: 2024-10-02

Responses

200

List of orders.

application/json

orderIdstring · uuidRequired

Unique identifier of the order.

Example: f41a3e45-6392-457c-8566-a282b5f3e177

externalReferencestringOptional

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

Example: your_order_id

subPartnerIdstringOptional

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

Example: your_sub_partner_id

orderTypestring · enumRequired

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

Example: BUYPossible values:

createdAtstring · date-timeRequired

Timestamp when the order was created.

Example: 2024-10-01T12:00:00Z

orderStatestring · enumRequired

Current state of the order.

Example: COMPLETEDPossible values:

orderStateUpdatedAtstring · date-timeRequired

Timestamp of the last order state change.

Example: 2024-10-01T13:00:00Z

paymentMethodstring · enumRequired

Payment method to be used for the order.

Example: CARDPossible values:

inputCurrencystringRequired

Fiat currency used to fund the order.

Example: USD

inputAmountstringRequired

Fiat amount used to fund the order.

Example: 100.00

outputCurrencystringRequired

Crypto currency purchased.

Example: BTC

outputAmountstringRequired

Amount of crypto received.

Example: 0.001

amountUsdstringRequired

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

Example: 100.00

processingFeestringRequired

Blockchain.com Pay processing fee denominated in inputCurrency.

Example: 1.00

processingFeeUsdstringRequired

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

Example: 1.00

partnerFeestringRequired

Partner fee denominated in inputCurrency.

Example: 0.50

partnerFeeUsdstringRequired

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

Example: 0.50

networkFeestringRequired

Blockchain network fee denominated in inputCurrency.

Example: 1.50

networkFeeUsdstringRequired

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

Example: 1.50

userIdstring · uuidRequired

Unique identifier of the user who placed the order.

Example: 2b6f0cc9-7b0c-4f3b-8f3b-6f0cc97b0c4f

targetWalletAddressstringRequired

Crypto wallet address that received the output currency.

Example: bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu

transactionHashstringOptional

Blockchain transaction hash. Only present for COMPLETED orders.

Example: 4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80

401

Missing or invalid API key.

application/json

get

/v1/orders

GET /partner-gateway/partner-api/v1/orders HTTP/1.1
Host: api.blockchain.info
X-Private-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "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"
  }
]

Get order by id

get

Returns order details for the given order id.

Authorizations

X-Private-API-KeystringRequired

Partner's private API key. Required on order endpoints; indicates a server-to-server call.

Path parameters

idstring · uuidRequired

Unique identifier of the order.

Example: f41a3e45-6392-457c-8566-a282b5f3e177

Responses

200

Order details.

application/json

orderIdstring · uuidRequired

Unique identifier of the order.

Example: f41a3e45-6392-457c-8566-a282b5f3e177

externalReferencestringOptional

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

Example: your_order_id

subPartnerIdstringOptional

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

Example: your_sub_partner_id

orderTypestring · enumRequired

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

Example: BUYPossible values:

createdAtstring · date-timeRequired

Timestamp when the order was created.

Example: 2024-10-01T12:00:00Z

orderStatestring · enumRequired

Current state of the order.

Example: COMPLETEDPossible values:

orderStateUpdatedAtstring · date-timeRequired

Timestamp of the last order state change.

Example: 2024-10-01T13:00:00Z

paymentMethodstring · enumRequired

Payment method to be used for the order.

Example: CARDPossible values:

inputCurrencystringRequired

Fiat currency used to fund the order.

Example: USD

inputAmountstringRequired

Fiat amount used to fund the order.

Example: 100.00

outputCurrencystringRequired

Crypto currency purchased.

Example: BTC

outputAmountstringRequired

Amount of crypto received.

Example: 0.001

amountUsdstringRequired

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

Example: 100.00

processingFeestringRequired

Blockchain.com Pay processing fee denominated in inputCurrency.

Example: 1.00

processingFeeUsdstringRequired

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

Example: 1.00

partnerFeestringRequired

Partner fee denominated in inputCurrency.

Example: 0.50

partnerFeeUsdstringRequired

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

Example: 0.50

networkFeestringRequired

Blockchain network fee denominated in inputCurrency.

Example: 1.50

networkFeeUsdstringRequired

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

Example: 1.50

userIdstring · uuidRequired

Unique identifier of the user who placed the order.

Example: 2b6f0cc9-7b0c-4f3b-8f3b-6f0cc97b0c4f

targetWalletAddressstringRequired

Crypto wallet address that received the output currency.

Example: bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu

transactionHashstringOptional

Blockchain transaction hash. Only present for COMPLETED orders.

Example: 4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80

401

Missing or invalid API key.

application/json

404

Order not found.

get

/v1/orders/{id}

GET /partner-gateway/partner-api/v1/orders/{id} HTTP/1.1
Host: api.blockchain.info
X-Private-API-Key: YOUR_API_KEY
Accept: */*

{
  "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"
}

Last updated 1 year ago