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

Account and NeroConnect

Updated 28 Apr 2026
NeroConnect

Account and NeroConnect

Read account details and build platform workflows with connected merchant account scope.

Account APINeroConnectConnected accounts

Account endpoints

MethodEndpointPurpose
GET/accountRead the authenticated merchant.
GET/connected-accountsList connected merchants under a NeroConnect platform.
POST/connected-accountsCreate a connected merchant under a NeroConnect platform.
GET/connected-accounts/{account_id}Retrieve one connected merchant.
PATCH/connected-accounts/{account_id}Update allowed connected merchant fields.

Get account

GET/account

Returns public account profile information for the authenticated merchant.

 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": "NPEE4E742AB2_6165",
    "name": "Demo Merchant Ltd",
    "email": "merchant@example.com",
    "country": "GB",
    "status": "active",
    "neroconnect_enabled": true
  }
}

Create connected account

This endpoint is for NeroConnect platform merchants. KYC verification remains managed by NeroPay. The platform can create the application profile and then use the returned connected account id with NeroPay-Account.

ParameterTypeRequiredDescription
business_company_namestringYesLegal or trading business name.
firstnamestringYesRepresentative first name.
lastnamestringYesRepresentative last name.
emailemail stringYesConnected merchant login and notification email.
country_codeISO country codeYesBusiness country, for example GB.
mobile_codestringYesDial code without plus symbol, for example 44.
mobilestringYesBusiness or representative mobile number.
business_typestringYesUse individual, company or the value shown in your onboarding form.
dobdate YYYY-MM-DDYesRepresentative date of birth.
address, city, postcodestringYesBusiness address fields.
metadataobjectOptionalShort non-sensitive references from your platform.
 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $secretKey,
        'Accept: application/json',
        'Content-Type: application/json',
        'X-NeroPay-Timestamp: ' . $timestamp,
        'X-NeroPay-Signature: ' . $signature,
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
    CURLOPT_POSTFIELDS => $rawBody,
]);

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

echo $response;

{
  "success": true,
  "data": {
    "account_id": "NP6454f52b_6165",
    "status": "created",
    "onboarding_status": "pending",
    "email": "jane.connected@example.com"
  }
}

Connected account errors

{
  "success": false,
  "error": {
    "code": "account_not_found",
    "message": "Connected account was not found.",
    "details": null
  }
}