POST
/
v2
/
onramp
/
orders
Create an onramp order
curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v2/onramp/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agreementAcceptedAt": "2025-04-24T00:00:00Z",
  "destinationAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
  "destinationNetwork": "base",
  "email": "test@example.com",
  "isQuote": false,
  "partnerOrderRef": "order-1234",
  "partnerUserRef": "user-1234",
  "paymentAmount": "100.00",
  "paymentCurrency": "USD",
  "paymentMethod": "GUEST_CHECKOUT_APPLE_PAY",
  "phoneNumber": "+12055555555",
  "phoneNumberVerifiedAt": "2025-04-24T00:00:00Z",
  "purchaseAmount": "10.000000",
  "purchaseCurrency": "USDC"
}'
{
  "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",
    "txHash": "0x363cd3b3d4f49497cf5076150cd709307b90e9fc897fdd623546ea7b9313cecb",
    "createdAt": "2025-04-24T00:00:00Z",
    "updatedAt": "2025-04-24T00:00:00Z"
  },
  "paymentLink": {
    "url": "https://pay.coinbase.com/v2/api-onramp/apple-pay?sessionToken=MWYwNWQwODktZTZlYy02OTdlLTgzZTYtMTI3NzcyOWJhNjM3",
    "paymentLinkType": "PAYMENT_LINK_TYPE_APPLE_PAY_BUTTON"
  }
}

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.

Body

application/json

Response

201
application/json

Successfully created an onramp order.

The response is of type object.