NeroPay Docs
Docs Home Terminal App Transaction Transfer EPOS NeroWeb Bookings API & Integrations Account & Registration Account Safety Partner Programme Support NeroPay global availability NeroPay Website System Status Changelog
Docs / API & Integrations
API & Integrations

Getting Started

Updated 28 Apr 2026
Getting started

Getting Started

Start with the base URL, JSON headers and a health check before sending production traffic.

Base URLJSONSandbox

Base URLs

EnvironmentBase URLUse it for
Livehttps://eu.neropay.app/v2Real payments, payouts and production merchant data.
Sandboxhttps://eu.neropay.app/v2/sandboxDevelopment and test calls before going live.

Required headers

Authorization: Bearer YOUR_SECRET_API_KEY
Accept: application/json
Content-Type: application/json

Health check

GET/health

Use this endpoint to confirm the API route is correctly deployed and returning JSON.

 true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $secretKey,
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $response;

{
  "success": true,
  "data": {
    "status": "ok",
    "version": "v2",
    "environment": "live"
  }
}

Sandbox authentication test

GET/sandbox/account

Use this endpoint to confirm that your sandbox credentials work.

 true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $secretKey,
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $response;

{
  "success": true,
  "data": {
    "account_id": "NPTEST123_1001",
    "mode": "sandbox",
    "name": "Sandbox Merchant"
  }
}

Recommended integration order

  1. Call GET /health and GET /account.
  2. Create a payment intent or hosted payment.
  3. Listen for webhook events.
  4. Retrieve transactions for reconciliation.
  5. Add payouts and terminal endpoints only after the basic payment flow works.