Skip to main content
POST
/
v2
/
onramp
/
limits
Get onramp user limits
curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v2/onramp/limits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentMethodType": "GUEST_CHECKOUT_APPLE_PAY",
  "userId": "+12055555555",
  "userIdType": "phone_number"
}
'
{
  "limits": [
    {
      "limitType": "weekly_spending",
      "currency": "USD",
      "limit": "500",
      "remaining": "400"
    },
    {
      "limitType": "lifetime_transactions",
      "limit": "15",
      "remaining": "12"
    }
  ]
}

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
​
paymentMethodType
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"

​
userId
string
required

The user identifier value. For phone_number type, this must be in E.164 format.

Example:

"+12055555555"

​
userIdType
enum<string>
required

The type of user identifier:

  • phone_number: A phone number in E.164 format associated with an onramp user.
Available options:
phone_number
Example:

"phone_number"

Response

Successfully retrieved user limits.

​
limits
object[]
required

The list of limits applicable to the user.