Skip to main content
POST
/
v2
/
payment-sessions
/
{paymentSessionId}
/
authorizations
/
coinbase
Authorize a payment session with a Coinbase account
curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/authorizations/coinbase \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "customer_id": "cust_12345",
    "order_reference": "order-67890"
  }
}
'
{
  "authorizationId": "authorization_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
  "paymentSessionId": "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
  "status": "pending",
  "amount": "1.00",
  "source": {
    "coinbaseUserId": "coinbase_user_abc123"
  },
  "metadata": {
    "customer_id": "cust_12345",
    "order_reference": "order-67890"
  },
  "createdAt": "2025-06-15T12:01:00.000Z",
  "updatedAt": "2025-06-15T12:01:00.000Z"
}

Authorizations

​
Authorization
string
header
required

A Coinbase OAuth Bearer token provided by the end user (payer). EntryGateway terminates the OAuth token and mints a scoped CAT (Coinbase Auth Token) JWT for downstream services.

Headers

​
X-Idempotency-Key
string

An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our Idempotency docs for more information on using idempotency keys.

Required string length: 1 - 128

Path Parameters

​
paymentSessionId
string
required

The unique identifier of the payment session to authorize via Coinbase. The ID of the payment session, a UUID prefixed by paymentSession_.

Pattern: ^paymentSession_[a-f0-9\-]{36}$
Example:

"paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

Body

application/json

A request to authorize a payment session using the payer's Coinbase account authenticated via OAuth.

​
metadata
object

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

Example:
{
  "customer_id": "cust_12345",
  "order_reference": "order-67890"
}

Response

Successfully created Coinbase authorization.

A hold placed on the payer's funds. Once authorized, the merchant can capture (collect) the funds. Only one authorization is allowed per session.

​
authorizationId
string

The unique identifier of the authorization.

Pattern: ^authorization_[a-f0-9\-]{36}$
Example:

"authorization_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

​
paymentSessionId
string

The ID of the payment session this authorization belongs to.

Pattern: ^paymentSession_[a-f0-9\-]{36}$
Example:

"paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

​
status
enum<string>

The current status of the authorization.

Available options:
pending,
succeeded,
failed
Example:

"pending"

​
amount
string

A decimal representation of the authorized amount, denominated in the session's asset.

Example:

"1.00"

​
error
object

An error that occurred during a payment operation.

Example:
{
  "code": "insufficient_funds",
  "message": "The payer does not have sufficient funds.",
  "occurredAt": "2025-06-15T12:00:00.000Z"
}
​
message
string

A human-readable message describing the outcome or status for display. Returned for x402 authorizations; omitted for other authorization flows unless documented otherwise.

Example:

"Your payment was successfully submitted"

​
metadata
object

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

Example:
{
  "customer_id": "cust_12345",
  "order_reference": "order-67890"
}
​
source
Payment Source Wallet · object

The payer for this authorization. For wallet authorizations, this is the blockchain address that signed the payloads. For Coinbase authorizations, this is the authenticated Coinbase account. This value is also reflected on the parent payment session's source field after a successful authorization.

Example:
{
  "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
  "network": "base",
  "asset": "usdc"
}
​
onchainTransactions
object[]

The onchain transactions associated with this authorization.

Example:
[
  {
    "transactionHash": "0xabc123def456789012345678901234567890abcdef1234567890abcdef123456",
    "network": "base"
  }
]
​
createdAt
string<date-time>

The UTC ISO 8601 timestamp at which the authorization was created.

Example:

"2025-06-15T12:00:00.000Z"

​
updatedAt
string<date-time>

The UTC ISO 8601 timestamp at which the authorization was last updated.

Example:

"2025-06-15T12:01:00.000Z"