Orders | Blockchain.com Pay

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

Returns either:

A list of recent orders, limited to the maximum of 50 orders, sorted by descending creation date.
If the externalReference query parameter is provided, returns a list of order details for orders that match requested external reference. It could be several orders.
If the walletAddress query parameter is provided, returns a list of order details for orders that match requested wallet address. It could be several orders.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/orders

Authorization

Query parameters

Response

Body

orderId*string

Unique identifier of the order

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

externalReferencestring

An optional external order reference set by the partner. It is limited to 100 characters.

Example: "your_order_id"

subPartnerIdstring

An optional 3rd party reference set by the partner. It is limited to 50 characters.

Example: "your_sub_partner_id"

orderType*enum

Type of the order. BUY for on-ramp, SELL for off-ramp

Example: "BUY"

BUYSELL

createdAt*string

Timestamp of the order creation

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

orderState*enum

Current state of the order

Example: "COMPLETED"

PENDINGWITHDRAWINGCOMPLETEDFAILED

orderStateUpdatedAt*string

Timestamp of the last order state change

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

paymentMethod*enum

Payment method used for the order

Example: "CARD"

CARDAPPLE_PAYGOOGLE_PAY

inputCurrency*string

Currency code used for funding the order

Example: "USD"

inputAmount*string

Amount of input currency used for the order

Example: "100.00"

outputCurrency*string

Currency code of the output currency

Example: "BTC"

outputAmount*string

Amount of output currency

Example: "0.001"

amountUsd*string

Amount of the transaction denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "100.00"

processingFee*string

Blockchain.com Pay processing fee denominated in inputCurrency

Example: "1.00"

processingFeeUsd*string

Blockchain.com Pay processing fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.00"

partnerFee*string

Partner fee denominated in inputCurrency

Example: "0.50"

partnerFeeUsd*string

Partner fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "0.50"

networkFee*string

Network fee denominated in inputCurrency

Example: "1.50"

networkFeeUsd*string

Transaction network fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.50"

userId*string

Unique identifier of the user

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

targetWalletAddress*string

Target wallet address of the crypto transaction

Example: "bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu"

transactionHashstring

Transaction hash of the crypto transaction. Will only be present for orders in COMPLETED state

Example: "4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80"

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

Get order by id

Returns order details for a given order id.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/orders/{id}

Authorization

Path parameters

id*string

Unique identifier of the order

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

Response

Body

orderId*string

Unique identifier of the order

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

externalReferencestring

An optional external order reference set by the partner. It is limited to 100 characters.

Example: "your_order_id"

subPartnerIdstring

An optional 3rd party reference set by the partner. It is limited to 50 characters.

Example: "your_sub_partner_id"

orderType*enum

Type of the order. BUY for on-ramp, SELL for off-ramp

Example: "BUY"

BUYSELL

createdAt*string

Timestamp of the order creation

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

orderState*enum

Current state of the order

Example: "COMPLETED"

PENDINGWITHDRAWINGCOMPLETEDFAILED

orderStateUpdatedAt*string

Timestamp of the last order state change

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

paymentMethod*enum

Payment method used for the order

Example: "CARD"

CARDAPPLE_PAYGOOGLE_PAY

inputCurrency*string

Currency code used for funding the order

Example: "USD"

inputAmount*string

Amount of input currency used for the order

Example: "100.00"

outputCurrency*string

Currency code of the output currency

Example: "BTC"

outputAmount*string

Amount of output currency

Example: "0.001"

amountUsd*string

Amount of the transaction denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "100.00"

processingFee*string

Blockchain.com Pay processing fee denominated in inputCurrency

Example: "1.00"

processingFeeUsd*string

Blockchain.com Pay processing fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.00"

partnerFee*string

Partner fee denominated in inputCurrency

Example: "0.50"

partnerFeeUsd*string

Partner fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "0.50"

networkFee*string

Network fee denominated in inputCurrency

Example: "1.50"

networkFeeUsd*string

Transaction network fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.50"

userId*string

Unique identifier of the user

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

targetWalletAddress*string

Target wallet address of the crypto transaction

Example: "bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu"

transactionHashstring

Transaction hash of the crypto transaction. Will only be present for orders in COMPLETED state

Example: "4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80"

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/orders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

Get orders

Returns either:

A list of recent orders, limited to the maximum of 50 orders, sorted by descending creation date.
If the externalReference query parameter is provided, returns a list of order details for orders that match requested external reference. It could be several orders.
If the walletAddress query parameter is provided, returns a list of order details for orders that match requested wallet address. It could be several orders.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/orders

Authorization

Query parameters

Response

Body

orderId*string

Unique identifier of the order

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

externalReferencestring

An optional external order reference set by the partner. It is limited to 100 characters.

Example: "your_order_id"

subPartnerIdstring

An optional 3rd party reference set by the partner. It is limited to 50 characters.

Example: "your_sub_partner_id"

orderType*enum

Type of the order. BUY for on-ramp, SELL for off-ramp

Example: "BUY"

BUYSELL

createdAt*string

Timestamp of the order creation

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

orderState*enum

Current state of the order

Example: "COMPLETED"

PENDINGWITHDRAWINGCOMPLETEDFAILED

orderStateUpdatedAt*string

Timestamp of the last order state change

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

paymentMethod*enum

Payment method used for the order

Example: "CARD"

CARDAPPLE_PAYGOOGLE_PAY

inputCurrency*string

Currency code used for funding the order

Example: "USD"

inputAmount*string

Amount of input currency used for the order

Example: "100.00"

outputCurrency*string

Currency code of the output currency

Example: "BTC"

outputAmount*string

Amount of output currency

Example: "0.001"

amountUsd*string

Amount of the transaction denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "100.00"

processingFee*string

Blockchain.com Pay processing fee denominated in inputCurrency

Example: "1.00"

processingFeeUsd*string

Blockchain.com Pay processing fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.00"

partnerFee*string

Partner fee denominated in inputCurrency

Example: "0.50"

partnerFeeUsd*string

Partner fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "0.50"

networkFee*string

Network fee denominated in inputCurrency

Example: "1.50"

networkFeeUsd*string

Transaction network fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.50"

userId*string

Unique identifier of the user

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

targetWalletAddress*string

Target wallet address of the crypto transaction

Example: "bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu"

transactionHashstring

Transaction hash of the crypto transaction. Will only be present for orders in COMPLETED state

Example: "4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80"

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

Get order by id

Returns order details for a given order id.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/orders/{id}

Authorization

Path parameters

id*string

Unique identifier of the order

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

Response

Body

orderId*string

Unique identifier of the order

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

externalReferencestring

An optional external order reference set by the partner. It is limited to 100 characters.

Example: "your_order_id"

subPartnerIdstring

An optional 3rd party reference set by the partner. It is limited to 50 characters.

Example: "your_sub_partner_id"

orderType*enum

Type of the order. BUY for on-ramp, SELL for off-ramp

Example: "BUY"

BUYSELL

createdAt*string

Timestamp of the order creation

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

orderState*enum

Current state of the order

Example: "COMPLETED"

PENDINGWITHDRAWINGCOMPLETEDFAILED

orderStateUpdatedAt*string

Timestamp of the last order state change

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

paymentMethod*enum

Payment method used for the order

Example: "CARD"

CARDAPPLE_PAYGOOGLE_PAY

inputCurrency*string

Currency code used for funding the order

Example: "USD"

inputAmount*string

Amount of input currency used for the order

Example: "100.00"

outputCurrency*string

Currency code of the output currency

Example: "BTC"

outputAmount*string

Amount of output currency

Example: "0.001"

amountUsd*string

Amount of the transaction denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "100.00"

processingFee*string

Blockchain.com Pay processing fee denominated in inputCurrency

Example: "1.00"

processingFeeUsd*string

Blockchain.com Pay processing fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.00"

partnerFee*string

Partner fee denominated in inputCurrency

Example: "0.50"

partnerFeeUsd*string

Partner fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "0.50"

networkFee*string

Network fee denominated in inputCurrency

Example: "1.50"

networkFeeUsd*string

Transaction network fee denominated in USD. Will be an approximate value in case of inputCurrency different than USD.

Example: "1.50"

userId*string

Unique identifier of the user

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

targetWalletAddress*string

Target wallet address of the crypto transaction

Example: "bc1q897va9he4zcppqgp3h7ue8hj7448ra0mr6xqtu"

transactionHashstring

Transaction hash of the crypto transaction. Will only be present for orders in COMPLETED state

Example: "4b1549abe58cface17d400bf50ff0fe0c2e2ca8121f4e3764d807dc841a2ab80"

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/orders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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