Pay REST API Overview
Versioning
All API calls should be made with a CBPAY-VERSION header which guarantees that your call is using the correct API version. Version is passed in as a date (UTC) of the implementation in YYYY-MM-DD format. New versions maintain backwards compatibility. The current version is 2023-10-01.
Authentication
Authenticated API requests should be made with headers, CBPAY-APP-ID and CBPAY-API-KEY. If authentication fails, a JSON object with an error message is returned with HTTP status 401.
Your app ID and API key are provided at onboarding.
If you integrated before API keys were issued during onboarding and want to use this API, contact us and we can provide you with your API key.
Rate Limiting
The Buy Quote API is rate limited to prevent abuse that would degrade our ability to maintain consistent API performance for all users. Throttling is enforced per endpoint by app ID at 100 requests per second. If your requests are being rate limited, HTTP response code 429 is returned with a rate_limit_exceeded error. Rate limiting is implemented using a sliding window algorithm.
Contact us to request a rate limit increase.
Supported Methods
The Pay API has the following endpoints:
Buy APIs
| Method | Description |
|---|---|
| Buy Config | Returns list of countries supported by Coinbase Pay, and the payment methods available in each country. |
| Buy Options | Returns supported fiat currencies and available crypto assets that can be passed into the Buy Quote API. |
| Buy Quote | Provides clients with a quote based on the asset the user would like to purchase, plus the network, the dollar payment, the payment currency, payment method, and country. |
| Onramp Session Token | Provides a secure way for the client to initialize the Pay SDK. |
| Transaction Status | Provides clients with real time status of a Pay transaction. |
| Transactions | Provides clients with their transactions for analytics purposes. |