API Reference

Comprehensive documentation for the CryptoPay REST API. Build powerful payment integrations with our developer-friendly endpoints.

Last updated: June 24, 2023

Getting Started

Essential information to get started with the API

Authentication
Error Handling
Pagination

Testing

Resources for testing API integration

Test Mode
Test Addresses
Webhook Testing

API Keys

Manage and use your API keys

Secret Key

API Endpoints

Explore all available endpoints in the CryptoPay API. Each endpoint is designed for maximum flexibility and ease of integration.

Payment Intents Objects

Payment Intents track the lifecycle of a customer payment through the CryptoPay system. They provide a unified interface for processing payments across multiple cryptocurrencies and payment methods.

Create Payment Intent

POST

/v1/payment_intents

Creates a new payment intent for processing a payment. This is the first step in the payment flow.

Retrieve Payment Intent

GET

/v1/payment_intents/:id

Retrieves the details of a specific payment intent by its unique identifier.

Response Object

{
  "id": "pi_10AbCdEfGhIjK1MnOpQrStUv",
  "object": "payment_intent",
  "amount": 2000,
  "amount_received": 2000,
  "currency": "usd",
  "payment_method_types": [
    "bitcoin",
    "ethereum"
  ],
  "status": "succeeded",
  "created": 1640995200,
  "description": "Payment for premium subscription",
  "metadata": {
    "order_id": "order_123",
    "customer_id": "cus_456"
  }
}

Need Help?

Our developer support team is here to help you integrate with CryptoPay. Get started quickly with our comprehensive resources.