Quick start

Get from zero to your first successful API call in a few minutes.

Prerequisites

  • A CardPlusPay account. If you don't have one, apply at cardpluspay.com/apply; once approved, you'll receive an email to log in.
  • An API key from the CardPlusPay dashboard (see Authentication).
  • HTTPS: all API requests must use https://api.cardpluspay.com.
  • Server-side only: never expose your API key in frontend or mobile app code.

Get your API key

  1. Log in to your CardPlusPay account.
  2. Open the Dashboard and go to API Keys.
  3. Create or copy your API key. Store it securely (e.g. in environment variables).

See Authentication for details and security notes.

First API call

Verify your key and the API with a simple request. The root endpoint returns API info and resource links.

cURL

curl -X GET "https://api.cardpluspay.com/v1/" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

$ch = curl_init('https://api.cardpluspay.com/v1/');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'X-API-Key: YOUR_API_KEY',
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$data = json_decode($response, true);
// $data['success'], $data['message'], $data['data'] (api_version, resources, etc.)

Example response

{
  "success": true,
  "message": "API information retrieved successfully",
  "data": {
    "api_version": "1.0.0",
    "resources": {
      "balance": "https://api.cardpluspay.com/v1/balance",
      "products": "https://api.cardpluspay.com/v1/catalog",
      "purchase": "https://api.cardpluspay.com/v1/orders",
      "orders": "https://api.cardpluspay.com/v1/orders"
    },
    "documentation": { "href": "https://docs.cardpluspay.com", "description": "..." },
    "contact": { "email": "support@cardpluspay.com", "description": "..." }
  }
}

If you see success: true and a data object, your integration is working. Next: read Concepts and Authentication, then use the API Reference to call balance, catalog, and orders.