Get an onramp order by ID

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/onramp/orders/{orderId} \
  --header 'Authorization: Bearer <token>'

{
  "order": {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentTotal": "100.75",
    "paymentSubtotal": "100",
    "paymentCurrency": "USD",
    "paymentMethod": "GUEST_CHECKOUT_APPLE_PAY",
    "purchaseAmount": "100.000000",
    "purchaseCurrency": "USDC",
    "fees": [
      {
        "type": "FEE_TYPE_EXCHANGE",
        "amount": "0.5",
        "currency": "USD"
      },
      {
        "type": "FEE_TYPE_NETWORK",
        "amount": "0.25",
        "currency": "USD"
      }
    ],
    "exchangeRate": "1",
    "destinationAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
    "destinationNetwork": "base",
    "status": "ONRAMP_ORDER_STATUS_COMPLETED",
    "createdAt": "2025-04-24T00:00:00Z",
    "updatedAt": "2025-04-24T00:00:00Z",
    "txHash": "0x363cd3b3d4f49497cf5076150cd709307b90e9fc897fdd623546ea7b9313cecb",
    "partnerUserRef": "user123"
  }
}

GET

onramp

orders

{orderId}

Get an onramp order by ID

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/onramp/orders/{orderId} \
  --header 'Authorization: Bearer <token>'

{
  "order": {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentTotal": "100.75",
    "paymentSubtotal": "100",
    "paymentCurrency": "USD",
    "paymentMethod": "GUEST_CHECKOUT_APPLE_PAY",
    "purchaseAmount": "100.000000",
    "purchaseCurrency": "USDC",
    "fees": [
      {
        "type": "FEE_TYPE_EXCHANGE",
        "amount": "0.5",
        "currency": "USD"
      },
      {
        "type": "FEE_TYPE_NETWORK",
        "amount": "0.25",
        "currency": "USD"
      }
    ],
    "exchangeRate": "1",
    "destinationAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
    "destinationNetwork": "base",
    "status": "ONRAMP_ORDER_STATUS_COMPLETED",
    "createdAt": "2025-04-24T00:00:00Z",
    "updatedAt": "2025-04-24T00:00:00Z",
    "txHash": "0x363cd3b3d4f49497cf5076150cd709307b90e9fc897fdd623546ea7b9313cecb",
    "partnerUserRef": "user123"
  }
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Path Parameters

orderId

string

required

The ID of the onramp order to retrieve.

Response

Successfully retrieved an onramp order.

order

object

required

An Onramp order.

Show child attributes

order.orderId

string

required

The ID of the onramp order.

Example:

"123e4567-e89b-12d3-a456-426614174000"

order.paymentTotal

string

required

The total amount of fiat to be paid, inclusive of any fees.

Example:

"100.75"

order.paymentSubtotal

string

required

The amount of fiat to be converted to crypto.

Example:

"100"

order.paymentCurrency

string

required

The fiat currency to be converted to crypto.

Example:

"USD"

order.paymentMethod

enum<string>

required

The type of payment method to be used to complete an onramp order.

Available options:

GUEST_CHECKOUT_APPLE_PAY

Example:

"GUEST_CHECKOUT_APPLE_PAY"

order.purchaseAmount

string

required

The amount of crypto to be purchased.

Example:

"100.000000"

order.purchaseCurrency

string

required

The crypto currency to be purchased.

Example:

"USDC"

order.fees

object[]

required

The fees associated with the order.

Show child attributes

order.fees.type

enum<string>

required

The type of fee.

Available options:

FEE_TYPE_NETWORK,

FEE_TYPE_EXCHANGE

Example:

"FEE_TYPE_NETWORK"

order.fees.amount

string

required

The amount of the fee.

Example:

"0.95"

order.fees.currency

string

required

The currency of the fee.

Example:

"USDC"

Example:

[
  {
    "type": "FEE_TYPE_EXCHANGE",
    "amount": "0.5",
    "currency": "USD"
  },
  {
    "type": "FEE_TYPE_NETWORK",
    "amount": "0.25",
    "currency": "USD"
  }
]

order.exchangeRate

string

required

The exchange rate used to convert fiat to crypto i.e. the crypto value of one fiat.

Example:

"1"

order.destinationAddress

string

required

The destination address to send the crypto to.

Example:

"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"

order.destinationNetwork

string

required

The network to send the crypto on.

Example:

"base"

order.status

enum<string>

required

The status of an onramp order.

Available options:

ONRAMP_ORDER_STATUS_PENDING_AUTH,

ONRAMP_ORDER_STATUS_PENDING_PAYMENT,

ONRAMP_ORDER_STATUS_PROCESSING,

ONRAMP_ORDER_STATUS_COMPLETED,

ONRAMP_ORDER_STATUS_FAILED

Example:

"ONRAMP_ORDER_STATUS_COMPLETED"

order.createdAt

string

required

The date and time the order was created.

Example:

"2025-04-24T00:00:00Z"

order.updatedAt

string

required

The date and time the order was last updated.

Example:

"2025-04-24T00:00:00Z"

order.txHash

string

The transaction hash of the order (only available once crypto has been sent).

Example:

"0x363cd3b3d4f49497cf5076150cd709307b90e9fc897fdd623546ea7b9313cecb"

order.partnerUserRef

string

The partner user reference ID.

Example:

"user123"

Onramp

Create an onramp order

⌘I

CDP API V2

REST API

Get an onramp order by ID

Authorizations

Path Parameters

Response