NeroPay API v2

Professional API reference for payments, platforms and merchant tools.

Build payments, connected accounts, money movement, NeroDisburse, Terminal, NeroCard, NeroPOS, NeroWeb, bookings, identity, compliance, proof workflows, support tickets and webhooks from one v2 API.

/v2Live base path

HMACSigned writes

ProductsPayment, POS, Web, Card, Disburse

Risk-readyKYC, compliance, proof, reserve

Quick start

Use the live v2 base URL for production. Sandbox endpoints are dry-run and do not create live payment, terminal, payout or local records.

https://eu.neropay.app/v2

Merchant mode

Use a merchant secret key to operate directly on that merchant account. Identity, compliance, proof, payments, support and resources are available for direct merchant integrations.

Platform mode

Use the platform key. Send NeroPay-Account to operate on a connected merchant. Keep your own customer-facing dashboard while NeroPay manages regulated flows.

Recommended platform flow: create connected account, create identity verification link, listen for KYC/compliance/proof webhooks, handle support tickets and only release marketplace UX once account and reserve states are safe.

Base request

curl https://eu.neropay.app/v2/account \
  -H "Authorization: Bearer sk_live_..." \
  -H "Accept: application/json"

Connected account request

curl https://eu.neropay.app/v2/balances \
  -H "Authorization: Bearer sk_live_platform_..." \
  -H "NeroPay-Account: NPEE4E742AB2_6165" \
  -H "Accept: application/json"

Updated 17 Apr 2026

Ready-to-Use Plugins

Use official NeroPay plugins when you want a faster launch without building every checkout, invoice, webhook and order status workflow manually.

NeroPay for WooCommerce

Accept card and wallet payments directly in WooCommerce, receive real-time status updates and support refunds from the store workflow. Download link is inside the section.

Open WooCommerce section →

NeroPay for Wix

Install NeroPay from the official Wix marketplace, configure public keys and redirect URLs, then test with sandbox checkout.

Open Wix section →

NeroPay for Odoo

Connect NeroPay to Odoo eCommerce, Website and Invoicing apps using the Odoo payment provider flow. Odoo 16, 17 and 18 app links are inside.

Open Odoo section →

NeroPay for Perfex CRM

Enable invoice payments, IPN callbacks and reconciliation inside Perfex CRM without building a custom gateway. Module download is inside.

Open Perfex CRM section →

NeroPay for Zapier

Create payment links and automate payment workflows between NeroPay and thousands of apps without code through Zapier.

Open Zapier section →

Plugins are recommended for standard store, invoice and no-code workflows. Use the API Reference when you need full platform control, connected accounts, custom onboarding, identity, compliance, proof and support flows.

Choose integration type

{
  "simple_storefront": "WooCommerce or Wix",
  "erp_or_invoice_flow": "Odoo or Perfex CRM",
  "automation": "Zapier",
  "custom_platform": "NeroPay API v2 + NeroConnect"
}

NeroPay for WooCommerce

Use the WooCommerce plugin to add secure NeroPay checkout to a WordPress store without building the hosted-payment, order-status and webhook flow from scratch.

Download WooCommerce plugin Use Payment API instead

Plugin package

Download the WooCommerce ZIP package and upload it from WordPress Admin → Plugins → Add New, or upload it manually by FTP.

Key features

Quick setup from the WordPress plugin area.
Secure processing through NeroPay APIs.
Real-time payment status updates through webhooks.
Refund support from the WooCommerce workflow where enabled.

Best for

Retail stores that need a standard checkout integration, payment confirmation, order reconciliation and optional advanced API checks.

1. Install and activateUpload the NeroPay WooCommerce plugin through WordPress Admin or FTP, then activate it from Plugins.

2. Configure credentialsOpen WooCommerce → Settings → Payments → NeroPay and enter your API key, merchant details and secret key.

3. Confirm webhooksKeep the webhook/IPN URL reachable so WooCommerce can move orders from pending to paid after NeroPay confirms payment.

Setting	Type	Required	Description
public_key	string	Required	Identifies the merchant account.
secret_key	string	Required	Server-side key used by the plugin for secure API actions.
webhook_url	string	Required	Receives payment success, failure or pending updates.
currency	enum	Required	Store currency such as GBP or EUR.

Typical WooCommerce payment

POST /v2/hosted-payments
{
  "identifier": "wc_order_1042",
  "amount": 49.99,
  "currency": "GBP",
  "details": "WooCommerce order #1042",
  "success_url": "https://store.example/checkout/order-received/1042",
  "cancel_url": "https://store.example/checkout/pay/1042",
  "ipn_url": "https://store.example/wp-json/neropay/webhook"
}

Order paid webhook

{
  "type": "transaction.succeeded",
  "data": {
    "transaction": {
      "identifier": "wc_order_1042",
      "status": "succeeded",
      "amount": 49.99,
      "currency": "GBP"
    }
  }
}

NeroPay for Wix

Use the Wix integration for a fast marketplace-style setup. Configure keys, redirect URLs and IPN URL, then send customers to NeroPay checkout.

Open official Wix app Use hosted payment links

Marketplace installation

Install NeroPay from the official Wix marketplace link, then configure Public Key, success URL, cancel URL and IPN URL.

1. Install from the marketplaceInstall the official NeroPay app, then connect it to your NeroPay merchant account.

2. Add API keysCopy the Public Key and Secret Key from the NeroPay dashboard. Keep secret keys out of browser code.

3. Configure URLsSet success, cancel and IPN URLs so payment status can return to the store.

4. Test in sandboxUse sandbox mode before switching to live keys and live checkout.

Field	Type	Required	Description
public_key	string	Required	NeroPay public key configured in the Wix app.
success_url	string	Required	Page shown after successful payment.
cancel_url	string	Required	Page shown when checkout is cancelled.
ipn_url	string	Required	Endpoint that receives payment confirmation.

For custom Wix backend flows, create hosted payments server-side. Browser-only flows should never expose the secret key.

Frontend checkout request

const payload = {
  public_key: "pk_live_...",
  identifier: "WEB-" + Date.now(),
  currency: "GBP",
  amount: 100.00,
  details: "Purchase via NeroPay",
  ipn_url: "https://yourdomain.com/ipn",
  success_url: "https://yourdomain.com/success",
  cancel_url: "https://yourdomain.com/cancel",
  customer_name: "John Doe",
  customer_email: "john@example.com"
};

IPN signature check

const expected = crypto
  .createHmac("sha256", secret)
  .update(data.amount + identifier)
  .digest("hex")
  .toUpperCase();

NeroPay for Odoo

Use NeroPay with Odoo eCommerce, Website and Invoicing apps. The integration uses NeroPay payment endpoints and keeps order or invoice state inside Odoo.

Odoo 16 app Odoo 17 app Odoo 18 app

Odoo App Store

Install the version that matches your Odoo branch, then enable NeroPay under Invoicing → Configuration → Payment Providers.

Supported environments

Odoo 16
Odoo 17
Odoo 18

Prerequisites

Access to Invoicing → Configuration → Payment Providers.
Active NeroPay merchant account.
Public and Secret API keys.
HTTPS endpoint for IPN callbacks.

1. Install the moduleUpload the neropay_payment module to Odoo add-ons or install it via Apps.

2. Enable providerRestart Odoo, update the Apps list, then select or create the NeroPay payment provider.

3. Configure keysEnter public and secret keys, choose sandbox or live mode and enable the provider.

4. Reconcile with IPNUse the NeroPay callback to mark invoices/orders paid after signature verification.

Flow	Description
eCommerce checkout	Create a hosted payment and redirect the customer to the checkout URL.
Invoice payment	Use the Odoo invoice number as `identifier` for reconciliation.
Sandbox testing	Use sandbox endpoint and test credentials before live deployment.
Troubleshooting	Check provider visibility, IPN reachability and HMAC signature configuration.

Odoo payment request

{
  "public_key": "YOUR_PUBLIC_KEY",
  "identifier": "ORDER12345",
  "currency": "GBP",
  "amount": 120.00,
  "details": "Sale of item #SKU1001",
  "ipn_url": "https://yourdomain.com/payment/neropay/ipn",
  "success_url": "https://yourdomain.com/payment/neropay/success",
  "cancel_url": "https://yourdomain.com/payment/neropay/cancel",
  "customer_name": "Jane Doe",
  "customer_email": "jane@example.com"
}

Response

{
  "success": "ok",
  "message": "Payment Initiated. Redirect to url.",
  "url": "https://eu.neropay.app/initiate/payment/checkout?payment_id=eJSAASDxdr..."
}

NeroPay for Perfex CRM

Enable NeroPay as a payment gateway inside Perfex CRM so clients can pay invoices online and Perfex can update invoice status from IPN callbacks.

Download Perfex CRM module Invoice API reference

Perfex module package

Download the module ZIP, extract it into the Perfex modules directory, then enable NeroPAY Payment Gateway from Setup → Payments.

Features

Online invoice payments.
GBP and EUR support where enabled.
Instant Payment Notification updates.
Success and failure redirects.
API credentials managed inside Perfex CRM.

Prerequisites

Running Perfex CRM instance.
NeroPay merchant account with API credentials.
Admin access to Perfex CRM.

1. Upload moduleExtract the NeroPay payment module and upload it to the Perfex modules directory.

2. Enable gatewayGo to Setup → Payments → Payment Gateways and enable the NeroPay gateway.

3. Configure credentialsEnter public and secret API keys and define supported currencies.

4. Verify IPNPerfex should listen at {your_perfex_url}/neropay_gateway/ipn and mark invoices paid after verification.

If invoices do not update, confirm the IPN URL, secret key and server logs before retrying payment creation.

Perfex invoice payment

POST /v2/hosted-payments
{
  "identifier": "perfex_invoice_8731",
  "amount": 120.00,
  "currency": "GBP",
  "details": "Perfex CRM invoice #8731",
  "success_url": "https://crm.example/invoices/8731?paid=1",
  "cancel_url": "https://crm.example/invoices/8731",
  "ipn_url": "https://crm.example/neropay_gateway/ipn"
}

IPN handling result

if signature_is_valid:
    record_payment(invoice_id)
    mark_invoice_as_paid()
else:
    log_invalid_ipn()

NeroPay for Zapier

Automate payment workflows between NeroPay and 5,000+ apps without code. Merchants can trigger workflows when a payment is received or create payment links from tools such as Sheets and CRMs.

Open Zapier integration Payment link API

No-code automation

Use Zapier to create payment links, log transactions, notify teams and sync payment events with CRMs, spreadsheets and 5,000+ apps.

1. Connect accountLog in to NeroPay, copy your Public API Key and paste it into the Zapier connection window.

2. Choose modeSelect Sandbox or Live mode depending on whether the workflow should test or process real payment links.

3. Create actionUse the Create Payment Request action to return a checkout URL instantly.

4. Automate follow-upSend payment notifications to Slack, log rows in Sheets, update CRM records or create invoices automatically.

Action field	Type	Required	Description
public_key	string	Required	NeroPay Public API key.
identifier	string	Required	Unique ID for the payment.
currency	enum	Required	Currency code such as GBP, EUR or IDR.
amount	decimal	Required	Payment amount.
details	string	Required	Description or order details.
ipn_url	string	Required	Instant payment notification URL.
customer_phone	string	Optional	Customer phone number.
customer_address	string	Optional	Billing address.

Zapier action response

{
  "success": "ok",
  "message": "Payment Initiated. Redirect to url.",
  "url": "https://eu.neropay.app/checkout?payment_id=EJX123"
}

Example automations

- Generate a payment link when a form is submitted
- Log each transaction in Google Sheets
- Send Slack or email notifications for successful payments
- Create invoices or notes in a CRM

Authentication

API v2 uses bearer authentication. Unsafe methods also require a timestamped HMAC signature and an idempotency key.

Header	Type	Required	Description
Authorization	string	Required	`Bearer {secret_key}`.
Accept	string	Required	Always `application/json`.
Content-Type	string	Required	Use `application/json` for JSON writes or multipart/form-data for file upload endpoints.
X-NeroPay-Timestamp	unix timestamp	Required	Required for POST/PATCH/PUT/DELETE.
X-NeroPay-Signature	string	Required	HMAC SHA-256 of `timestamp.raw_body` using the secret key.
Idempotency-Key	string	Required	Required for writes that create or mutate state.

Never expose secret keys in browser code. Use server-side calls for signed writes.

Node.js signature

const timestamp = Math.floor(Date.now() / 1000).toString();
const rawBody = JSON.stringify(payload);
const signature = crypto
  .createHmac('sha256', secretKey)
  .update(`${timestamp}.${rawBody}`)
  .digest('hex');

Signed POST headers

POST /v2/payment-intents
Authorization: Bearer sk_live_...
Accept: application/json
Content-Type: application/json
Idempotency-Key: order_1001_attempt_1
X-NeroPay-Timestamp: 1777411120
X-NeroPay-Signature: 9ea0...

Headers

Headers control JSON responses, connected account scoping, public/client key context and retry safety.

Header	Type	Required	Description
NeroPay-Account	string	Optional	Connected account ID such as NPEE4E742AB2_6165. Platforms use it to act on a connected merchant.
X-NeroPay-Client-Key	string	Optional	Dashboard-visible client key. Format: unique_account_id + underscore + merchant_id.
X-NeroPay-Public-Key	string	Optional	Public key from API credentials.
Idempotency-Key	string	Required	Unique per business operation. Reuse only for exact retries.

Connected account scoping works with payments, balances, identity, compliance, proof, support and resource APIs where enabled.

Connected account header

curl https://eu.neropay.app/v2/account \
  -H "Authorization: Bearer sk_live_platform_..." \
  -H "NeroPay-Account: NPEE4E742AB2_6165" \
  -H "X-NeroPay-Client-Key: NPEE4E742AB2_6165" \
  -H "Accept: application/json"

Pagination

List endpoints use page-based pagination when the underlying controller returns a collection.

Query	Type	Default	Description
page	integer	1	Page number.
per_page	integer	25	Number of records per page.
q/search	string	—	Search by supported columns.
status	enum	—	Filter by status where supported.
from / to	date/datetime	—	Filter by created date where supported.
sort	string	-id	Use leading minus for descending order where supported.

Pagination appears inside meta.pagination. Some single-object APIs return only data.

Pagination response

{
  "success": true,
  "data": {
    "account_id": "NPEE4E742AB2_6165",
    "requests": []
  },
  "meta": {
    "pagination": {
      "current_page": 1,
      "per_page": 25,
      "total": 0,
      "last_page": 1
    }
  }
}

Errors

Errors return a consistent JSON object with an application code and human-readable message.

HTTP	Code	Meaning
400	bad_request	Malformed request.
401	unauthenticated	Missing or invalid API key.
403	forbidden	The authenticated account cannot access the resource.
404	endpoint_not_found / not_found	Route or object was not found.
405	resource_read_only	Resource exists but the requested write method is not enabled.
409	idempotency_conflict	The same idempotency key was reused with a different body.
422	validation_error	Invalid fields.
429	rate_limited	Too many requests.

Validation error

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "The amount field is required.",
    "details": {
      "amount": ["The amount field is required."]
    }
  }
}

Idempotency

Use an idempotency key for each write operation that creates or changes financial state.

Good

order_1001_payment_attempt_1 reused only when retrying the same body.

Avoid

Do not reuse one key for different payments, payouts, refunds or proof submissions.

Safe retry

curl https://eu.neropay.app/v2/payouts \
  -X POST \
  -H "Authorization: Bearer sk_live_..." \
  -H "Idempotency-Key: payout_1001_attempt_1" \
  -H "Content-Type: application/json" \
  -d '{"amount":1.00,"currency":"GBP","bank_account_id":"ba_123"}'

Account API

Retrieve the authenticated merchant account and core onboarding state.

GET/account

Returns the authenticated merchant or the connected merchant when NeroPay-Account is supplied.

GET/connected-accounts

Lists connected merchants for a NeroConnect platform.

POST/connected-accounts

Creates a connected merchant.

GET/connected-accounts/{account_id}

Retrieves one connected merchant.

PATCH/connected-accounts/{account_id}

Updates connected account fields and can trigger account.update webhooks.

Attribute	Type	Required	Description
account_id	string	Read-only	Public API account ID.
business_company_name	string	Optional	Company or trading name.
email	string	Required	Primary merchant email.
status	enum	Read-only	active, pending, banned or review state.
kyc_status	enum	Read-only	pending, verified or rejected.
neroconnect_email_sms_handle	enum	Optional	neropay or platform. Controls merchant-facing notification delegation.

Create connected account is the beginning, not the end of onboarding. Developers should also create identity verification links, handle compliance document requests and subscribe to KYC/compliance webhooks.

Create connected account request

POST /v2/connected-accounts
{
  "business_company_name": "Demo Connected Merchant Ltd",
  "firstname": "Jane",
  "lastname": "Merchant",
  "email": "connected.demo@example.com",
  "country_code": "GB",
  "mobile_code": "44",
  "mobile": "7700000000",
  "business_type": "company",
  "nationality": "GB",
  "company_registration_number": "12345678",
  "representative_job_title": "Director",
  "rep_is_director": true,
  "rep_is_executive": true,
  "rep_is_owner": true,
  "rep_ownership_percent": 100,
  "company_declaration": true,
  "address": "1 Demo Street",
  "city": "London",
  "postcode": "SW1A 1AA",
  "dob": "1990-01-01",
  "industry": "5812",
  "merchant_website_or_product_description": "Online retail platform merchant"
}

Connected account response

{
  "success": true,
  "data": {
    "account": {
      "id": "NPEE4E742AB2_6165",
      "business_company_name": "Demo Connected Merchant Ltd",
      "email": "connected.demo@example.com",
      "status": "pending",
      "kyc_status": "pending",
      "created_at": "2026-04-28T18:00:00.000000Z"
    }
  }
}

NeroConnect connected accounts

Platforms can create merchants, view balances, manage default platform fees and operate by sending the connected account header.

Concept	Type	Description
Connected account ID	string	Format is unique_account_id + underscore + merchant_id.
NeroPay-Account header	string	Scopes API calls to a connected merchant.
Notification handling	enum	neropay means NeroPay sends email/SMS; platform means platform handles merchant-facing notifications from webhooks.
KYC/compliance	workflow	Must be completed after create account. Use Identity and Compliance APIs plus webhooks.

Connected accounts should not be treated as fully ready until KYC, payout bank setup, compliance requests and reserve/proof checks are clear.

Get connected account

GET /v2/connected-accounts/NPEE4E742AB2_6165

Update connected account

PATCH /v2/connected-accounts/NPEE4E742AB2_6165
{
  "neroconnect_status": "active",
  "metadata": {
    "source": "platform-admin"
  }
}

Payment API

Create hosted checkouts, API payment intents and terminal payments. Payment API is separate from resources and appears in the main menu.

POST/hosted-payments

Creates a hosted checkout URL.

POST/payments

Creates an API payment intent / pending payment.

POST/payment-intents

Explicit payment intent endpoint.

POST/terminal/payments

Sends a payment action to a terminal reader.

Field	Type	Required	Description
amount	decimal	Required	Payment amount in major units, e.g. 15.99.
currency	enum	Required	Currency such as GBP.
reference	string	Optional	Your order/payment reference.
description/details	text	Optional	Customer-facing or internal description.
connect_application_fee	decimal	Optional	Platform fee charged for a connected account payment. Strongly recommended for platform monetisation.
metadata	object	Optional	Additional key/value data returned in responses and webhooks where supported.

connect_application_fee is important: send it per payment when your platform takes a fee. If the request omits it, the default connect application fee configured in the dashboard can be used. If a request sends a fee, the default is not charged again.

No raw card data: API v2 does not accept keyed card payments. If an order must be allocated across more than one merchant, create separate payment intents and link them with your own reference or metadata.order_id.

Payment intent request

POST /v2/payment-intents
{
  "amount": 15.99,
  "currency": "GBP",
  "description": "Order #1001",
  "reference": "ORDER-1001",
  "payment_method_types": ["card"],
  "connect_application_fee": 0.30,
  "metadata": {
    "cart_id": "cart_1001"
  }
}

Payment response

{
  "success": true,
  "data": {
    "payment": {
      "id": "pi_np_01",
      "status": "pending",
      "amount": 15.99,
      "currency": "GBP",
      "reference": "ORDER-1001",
      "connect_application_fee": 0.30
    },
    "transaction": {
      "id": 5663230,
      "status": "pending",
      "is_reserve": false,
      "proof_status": null
    }
  }
}

Multi-party charge pattern

# Create separate payment intents when an order needs multiple parties.
# Send NeroPay-Account for the connected merchant and connect_application_fee
# for the platform fee on that connected account payment.

POST /v2/payment-intents
NeroPay-Account: NPEE4E742AB2_6165
{
  "amount": 7.50,
  "currency": "GBP",
  "description": "Connected merchant part for order #1001",
  "reference": "ORDER-1001-PART-B",
  "connect_application_fee": 0.25,
  "metadata": {
    "order_id": "ORDER-1001",
    "part": "connected_merchant"
  }
}

Payment Links / LinkPay

Create and inspect LinkPay checkout links. LinkPay records are separated from generic API payments.

GET/payment-links

Lists LinkPay records.

POST/payment-links

Creates a payment link.

GET/payment-links/{id}

Retrieves one payment link.

Field	Type	Required	Description
currency	enum	Required	Payment currency.
amount	decimal	Required	Amount in major units.
details	text	Required	Description shown to the buyer.
customer_name	string	Optional	Pre-filled customer name.
customer_email	string	Optional	Pre-filled customer email.
success_url	string	Optional	Redirect URL after success.
cancel_url	string	Optional	Redirect URL after cancellation.
ipn_url	string	Optional	Webhook/IPN URL for this payment link.

Create payment link

POST /v2/payment-links
{
  "currency": "GBP",
  "amount": 9.99,
  "details": "Product or service",
  "customer_name": "Jane Guest",
  "customer_email": "jane@example.com",
  "success_url": "https://example.com/success",
  "cancel_url": "https://example.com/cancel",
  "ipn_url": "https://example.com/webhooks/neropay"
}

Payment link response

{
  "success": true,
  "data": {
    "payment_link": {
      "id": 1042,
      "amount": 9.99,
      "currency": "GBP",
      "status": "pending",
      "checkout_url": "https://pay.neropay.app/link/np_..."
    }
  }
}

Transactions

List, retrieve, refund and cancel transactions. High-risk transactions can expose proof and reserve state, so check transaction state before treating funds as fully available.

POST/transactions

Legacy alias for creating hosted/API transaction where enabled.

GET/transactions

Lists transactions.

GET/transactions/{id}

Retrieves one transaction.

POST/transactions/{id}/refund

Refunds a transaction.

POST/transactions/{id}/cancel

Cancels a pending transaction.

Field	Type	Description
id	integer	Internal transaction ID.
account_id	string	Merchant or connected account ID.
reference	string	NeroPay or merchant reference.
np_main_trx	string	Processor/payment identifier where available.
status	enum	pending, succeeded, failed, cancelled, refunded.
is_reserve	boolean	Whether funds are currently held in reserve.
reserve_amount	decimal	Amount held from available balance.
proof_status	enum	requested, submitted, approved, rejected or null.

A succeeded transaction can still have reserve/proof state. Do not show funds as fully available until reserve_amount is zero and proof status is clear.

List transactions

GET /v2/transactions?per_page=25&status=succeeded

Transaction response

{
  "success": true,
  "data": {
    "transaction": {
      "id": 5663230,
      "account_id": "NPEE4E742AB2_6165",
      "reference": "NP-EGQX9271-cf013",
      "np_main_trx": "pi_3TENnmPwvCBPpp9M1H3YZnSr",
      "status": "succeeded",
      "amount": 1.00,
      "currency": "GBP",
      "is_reserve": false,
      "reserve_amount": 0,
      "proof_status": "approved",
      "created_at": "2026-03-24T05:47:00.000000Z"
    }
  }
}

Refund request

POST /v2/transactions/5663230/refund
{
  "amount": 1.00,
  "reason": "requested_by_customer"
}

Transaction Proof API

Submit proof files and buyer/shipping details when a transaction is flagged by high-value or risk logic. This API is available for merchants and connected accounts.

GET/transactions/{id}/proof

Returns proof request and transaction reserve state.

POST/transactions/{id}/proof

Submits proof details and invoice/shipping file.

Field	Type	Required	Description
invoice_file	file	Optional	JPG, PNG, PDF or WEBP. Required when staff/platform requested an invoice file.
courier_company	string	Optional	Shipping courier.
tracking_number	string	Optional	Tracking number.
buyer_firstname	string	Optional	Buyer first name.
buyer_lastname	string	Optional	Buyer last name.
buyer_phone	string	Optional	Buyer phone number.
buyer_email	string	Optional	Buyer email.
merchant_notes	text	Optional	Merchant notes for the review team.

Submitting proof publishes transaction.proof_submitted. Staff approval/rejection publishes transaction.proof_approved or transaction.proof_rejected. Approved reserve releases can publish balance.reserve_released.

Get proof request response

{
  "success": true,
  "data": {
    "transaction": {
      "id": 5663230,
      "account_id": "NPEE4E742AB2_6165",
      "reference": "NP-EGQX9271-cf013",
      "np_main_trx": "pi_3TENnmPwvCBPpp9M1H3YZnSr",
      "status": "succeeded",
      "amount": 1,
      "remark": "make_payment",
      "details": "Payment successful via Online | PI: pi_3TENnmPwvCBPpp9M1H3YZnSr",
      "is_reserve": false,
      "reserve_amount": 0,
      "created_at": "2026-03-24T05:47:00.000000Z"
    },
    "proof_request": {
      "id": 925,
      "transaction_id": 5663230,
      "status": "approved",
      "courier_company": null,
      "tracking_number": null,
      "buyer": {
        "firstname": null,
        "lastname": null,
        "phone": null,
        "email": null
      },
      "has_invoice_file": false,
      "merchant_notes": null,
      "staff_notes": "test"
    }
  }
}

Submit proof multipart

POST /v2/transactions/5663230/proof
Content-Type: multipart/form-data

invoice_file=@invoice.pdf
courier_company=Royal Mail
tracking_number=RM123456789GB
buyer_firstname=Jane
buyer_lastname=Customer
buyer_phone=+447700900000
buyer_email=jane@example.com
merchant_notes=Invoice and delivery information attached.

Balances

Read available, pending, instant, standard and reserve balances. Reserve balance is important for high-risk and proof-held funds.

GET/balances

Returns wallet balances.

GET/balance

Alias of /balances.

Field	Type	Description
available_balance	decimal	Funds available for use.
instant_available	decimal	Instant payout availability.
standard_available	decimal	Standard payout availability.
reserve_balance	decimal	Funds held in reserve due to proof/risk/compliance.
currency	enum	Wallet currency.

Balances response

{
  "success": true,
  "data": {
    "account_id": "NPEE4E742AB2_6165",
    "wallets": [
      {
        "currency": "GBP",
        "available_balance": 50.01,
        "pending_balance": 0,
        "instant_available": 0,
        "standard_available": 50.01,
        "reserve_balance": 0
      }
    ]
  }
}

Wallet Transactions

Audit wallet movement separately from payment transactions. Use this for balance ledger reconciliation.

GET/wallet-transactions

Lists wallet balance transactions.

GET/wallet-transactions/{id}

Retrieves one wallet ledger row.

Field	Type	Description
txn_id	string	Ledger transaction ID.
type	enum	credit/debit/hold/release depending on implementation.
amount	decimal	Amount moved.
balance_before	decimal	Balance before movement where available.
balance_after	decimal	Balance after movement where available.
notes	text	Internal or merchant-facing notes.

Wallet transactions request

GET /v2/wallet-transactions?per_page=25

Wallet transaction response

{
  "success": true,
  "data": [
    {
      "id": 901,
      "txn_id": "wb_901",
      "currency": "GBP",
      "amount": 15.99,
      "type": "credit",
      "status": "completed",
      "notes": "Payment received",
      "created_at": "2026-04-28T18:00:00.000000Z"
    }
  ]
}

Payouts & Schedule

Create and inspect payout requests and manage payout schedule. Payout creation can trigger proof/risk checks and Perfex review tasks.

GET/payouts

Lists payouts.

POST/payouts

Creates a payout request.

POST/payouts/request

Legacy alias for create payout.

GET/payouts/{id}

Retrieves one payout.

GET/payout-schedule

Gets payout schedule.

PATCH/payout-schedule

Updates payout schedule.

GET/transfer-schedule

Legacy alias of payout schedule.

PATCH/transfer-schedule

Legacy alias of update payout schedule.

Field	Type	Required	Description
amount	decimal	Required	Payout amount.
currency	enum	Required	Currency.
transfer_speed	enum	Optional	instant or standard.
bank_account_id	string	Optional	Destination bank reference.
reference	string	Optional	Statement or internal reference.

Transfers and payouts should not bypass risk controls. High-risk payout requests can create proof requirements, risk flags, tasks and webhooks.

Create payout

POST /v2/payouts
{
  "amount": 25.00,
  "currency": "GBP",
  "transfer_speed": "instant",
  "bank_account_id": "ba_123",
  "reference": "PAYOUT-1001"
}

Schedule response

{
  "success": true,
  "data": {
    "mode": "manual",
    "instant_enabled": true,
    "standard_enabled": true
  }
}

Disputes

Disputes belong under Money Movement because they affect payment risk, settlement and operational review.

GET/disputes

Lists disputes.

GET/disputes/{id}

Retrieves one dispute.

Field	Type	Description
trx_number	string	Related transaction reference.
payment_number	string	Payment identifier.
dispute_reason	string	Reason code or description.
dispute_status	enum	open, won, lost, under_review etc.
customer_email	string	Customer email when available.

Disputes are read-only in API v2. Use dashboards or operational flows for evidence submission if enabled.

List disputes

GET /v2/disputes?status=open&per_page=25

Dispute response

{
  "success": true,
  "data": [
    {
      "id": 120,
      "trx_number": "NP-EGQX9271-cf013",
      "payment_number": "pi_...",
      "dispute_reason": "fraudulent",
      "dispute_status": "under_review",
      "customer_email": "buyer@example.com"
    }
  ]
}

Loans

Loans and financing records are grouped under Money Movement and are read-only through API v2.

GET/loans

Lists loan/financing records.

GET/loans/{id}

Retrieves one loan record.

Field	Type	Description
offer_id	string	Financing offer identifier.
status	enum	offer, active, paid, declined etc.
campaign_type	string	Campaign/category.
financing_type	string	Financing type.
created_at	datetime	Record creation time.

List loans

GET /v2/loans?per_page=25

Loan response

{
  "success": true,
  "data": [
    {
      "id": 88,
      "offer_id": "offer_123",
      "status": "active",
      "campaign_type": "working_capital",
      "financing_type": "merchant_cash_advance"
    }
  ]
}

NeroDisburse Bank Accounts

Bank accounts are documented under NeroDisburse. API responses never expose full account numbers, sort codes, IBANs or routing numbers.

GET/bank-accounts

Lists safe payout bank references.

POST/bank-accounts

Adds a payout bank account through the NeroDisburse bridge.

GET/nerodisburse/bank-accounts

Lists NeroDisburse bank accounts.

POST/nerodisburse/bank-accounts

Creates a NeroDisburse bank account.

Field	Type	Required	Description
account_name	string	Required	Display name for the destination.
bank_name	string	Optional	Bank name.
sort_code	string	Optional	GB sort code for GB bank accounts.
account_number	string	Optional	GB account number for GB bank accounts.
iban	string	Optional	IBAN for supported international accounts.
currency	enum	Required	Currency.
use_for	enum	Optional	supplier, payout, merchant etc.
is_default	boolean	Optional	Set as default destination.

Create GB bank account

POST /v2/nerodisburse/bank-accounts
{
  "account_name": "Main payout account",
  "bank_name": "Demo Bank",
  "sort_code": "000000",
  "account_number": "00012345",
  "currency": "GBP",
  "use_for": "supplier",
  "is_default": true,
  "full_name": "Jane Merchant",
  "email": "jane@example.com",
  "country": "GB"
}

Create IBAN account

POST /v2/nerodisburse/bank-accounts
{
  "account_name": "EUR payout account",
  "iban": "LT121000011101001000",
  "currency": "EUR",
  "use_for": "supplier",
  "full_name": "Jane Merchant",
  "email": "jane@example.com",
  "country": "LT"
}

NeroDisburse Payouts

Create supplier or connected disbursement payouts using saved bank accounts.

GET/nerodisburse/payouts

Lists NeroDisburse payouts.

POST/nerodisburse/payouts

Creates pending NeroDisburse payout.

GET/nerodisburse/payouts/{id}

Retrieves one NeroDisburse payout.

Field	Type	Required	Description
amount	decimal	Required	Amount.
currency	enum	Required	Currency.
transfer_speed	enum	Optional	instant or standard.
bank_account_id	string	Required	Saved bank account reference.
reference	string	Optional	Payout reference.
note	text	Optional	Supplier payout note.

Create NeroDisburse payout

POST /v2/nerodisburse/payouts
{
  "amount": 10.00,
  "currency": "GBP",
  "transfer_speed": "instant",
  "bank_account_id": "ba_123",
  "reference": "ND1001",
  "note": "Supplier payout"
}

NeroDisburse payout response

{
  "success": true,
  "data": {
    "payout": {
      "id": 3021,
      "status": "pending",
      "amount": 10.00,
      "currency": "GBP",
      "reference": "ND1001"
    }
  }
}

NeroDisburse Payments

Create disbursement payment records where enabled by the NeroDisburse controller.

POST/nerodisburse/payments

Creates a NeroDisburse payment/disbursement request.

Use this endpoint where your integration needs NeroDisburse payment creation rather than a standard payout request. Risk and payout availability rules still apply.

Create NeroDisburse payment

POST /v2/nerodisburse/payments
{
  "amount": 10.00,
  "currency": "GBP",
  "recipient": {
    "name": "Supplier Ltd",
    "email": "supplier@example.com"
  },
  "bank_account_id": "ba_123",
  "reference": "SUP-1001"
}

Terminal Payments

Send in-person payment actions to a registered terminal reader.

POST/terminal/payments

Creates and sends a terminal payment action.

POST/terminal/readers/{reader_id}/cancel-action

Cancels the current reader action.

Field	Type	Required	Description
amount	decimal	Required	Amount.
currency	enum	Required	Currency.
reader_id	string	Required	Terminal reader ID.
location_id	string	Required	Terminal location ID.
description	text	Optional	Payment description.
reference	string	Optional	Reference shown in transaction history.

Create terminal payment

POST /v2/terminal/payments
{
  "amount": 12.50,
  "currency": "GBP",
  "reader_id": "tmr_123",
  "location_id": "tml_123",
  "description": "Counter payment",
  "reference": "TERM-1001"
}

Cancel reader action

POST /v2/terminal/readers/tmr_123/cancel-action
{}

Terminal Locations

Create, list and manage terminal locations. Location creation uses the terminal bridge route.

GET/locations

Lists terminal/NeroPOS locations.

POST/locations

Legacy alias to create terminal location.

GET/terminal/locations

Lists terminal locations.

POST/terminal/locations

Creates a terminal location.

GET/locations/{id}

Retrieves one location.

PATCH/locations/{id}

Updates a location.

DELETE/locations/{id}

Deletes where enabled.

Field	Type	Required	Description
display_name	string	Required	Location display name.
line1	string	Required	Address line 1.
city	string	Required	City.
postal_code	string	Required	Postal code.
country	enum	Required	ISO country code.
is_default	boolean	Optional	Set default location.
tipping_enabled	boolean	Optional	Enable tipping for terminal/POS flows.

Create location

POST /v2/terminal/locations
{
  "display_name": "Main Store",
  "line1": "1 Demo Street",
  "city": "London",
  "postal_code": "SW1A 1AA",
  "country": "GB",
  "is_default": true
}

Location response

{
  "success": true,
  "data": {
    "id": 100,
    "display_name": "Main Store",
    "stripe_location_id": "tml_...",
    "city": "London",
    "country": "GB"
  }
}

Terminal Readers

GET/readers

Lists readers.

POST/readers

Legacy alias to register reader.

GET/terminal/readers

Lists terminal readers.

POST/terminal/readers

Registers a reader.

DELETE/terminal/readers/{id}

Deletes/unlinks a reader.

Field	Type	Required	Description
label	string	Required	Reader label.
location_id	string	Required	Location ID.
registration_code	string	Required	Pairing/registration code from device.
reader_serial_number	string	Read-only	Device serial where available.
reader_status	enum	Read-only	online/offline/unknown.

Create reader

POST /v2/terminal/readers
{
  "label": "Front counter",
  "location_id": "tml_123",
  "registration_code": "simulated-wpe"
}

Reader response

{
  "success": true,
  "data": {
    "id": 44,
    "label": "Front counter",
    "reader_id": "tmr_123",
    "status": "online"
  }
}

Devices

Read-only terminal/device records for fleet visibility.

GET/devices

Lists device rows.

GET/devices/{id}

Retrieves one device.

Field	Type	Description
device_id	string	Internal device ID.
reader_id	string	Linked reader ID.
reader_serial	string	Serial number.
reader_label	string	Display label.
status	enum	Device status.

NeroCard Cards

NeroCard card records are read-only in API v2 and are separate from payment cards.

GET/nerocards

Lists NeroCard cards.

GET/nerocards/{id}

Retrieves one NeroCard card.

Field	Type	Description
cardholder_name	string	Cardholder name.
brand	string	Card brand.
last4	string	Last four digits.
status	enum	active, inactive, cancelled, blocked etc.
card_pin	hidden	Never returned.

List NeroCards

GET /v2/nerocards?status=active

NeroCard response

{
  "success": true,
  "data": [
    {
      "id": 77,
      "cardholder_name": "Jane Merchant",
      "brand": "Visa",
      "last4": "4242",
      "status": "active"
    }
  ]
}

NeroCard Cardholders

Read NeroCard cardholder records.

GET/nerocardholders

Lists cardholders.

GET/nerocardholders/{id}

Retrieves one cardholder.

Field	Type	Description
name	string	Cardholder name.
email	string	Email.
phone	string	Phone.
stripe_cardholder_id	string	External cardholder identifier when present.
created_at	datetime	Creation time.

List cardholders

GET /v2/nerocardholders?per_page=25

Cardholder response

{
  "success": true,
  "data": [
    { "id": 5, "name": "Jane Merchant", "email": "jane@example.com", "phone": "+447700900000" }
  ]
}

NeroCard Transactions

Read NeroCard issuing transactions separately from wallet and payment transactions.

GET/nerocard-transactions

Lists issuing/NeroCard transactions.

GET/nerocard-transactions/{id}

Retrieves one NeroCard transaction.

Field	Type	Description
stripe_issuing_transaction_id	string	External issuing transaction ID.
merchant_name	string	Merchant name on the card transaction.
amount	decimal	Transaction amount.
merchant_amount	decimal	Original merchant amount where different.
platform_fee_amount	decimal	Platform fee amount if applied.
net_amount	decimal	Net ledger amount.
status	enum	pending, posted, reversed etc.
type	enum	purchase, refund, adjustment etc.

List NeroCard transactions

GET /v2/nerocard-transactions?per_page=25

NeroCard transaction response

{
  "success": true,
  "data": [
    {
      "id": 1901,
      "stripe_issuing_transaction_id": "ipi_...",
      "merchant_name": "Demo Store",
      "amount": 12.50,
      "status": "posted",
      "type": "purchase"
    }
  ]
}

Customers

Create and manage NeroPOS/NeroPay customer records.

GET/customers

Lists customers.

POST/customers

Creates a customer.

GET/customers/{id}

Retrieves one customer.

PATCH/customers/{id}

Updates a customer.

Field	Type	Required	Description
name	string	Required	Customer name.
email	string	Optional	Email.
phone	string	Optional	Phone.
postcode	string	Optional	Postcode.
address1/address2	string	Optional	Address lines.
city	string	Optional	City.
instructions	text	Optional	Delivery or customer notes.

Create customer

POST /v2/customers
{
  "name": "Jane Customer",
  "email": "jane@example.com",
  "phone": "01234567890",
  "postcode": "SW1A 1AA",
  "address1": "1 Demo Street",
  "city": "London"
}

Customer response

{
  "success": true,
  "data": {
    "id": 1001,
    "name": "Jane Customer",
    "email": "jane@example.com",
    "phone": "01234567890"
  }
}

Categories & Products

Keep product catalogue data in sync for NeroPOS and NeroWeb menus.

GET/categories

Lists categories.

POST/categories

Creates category.

PATCH/categories/{id}

Updates category.

DELETE/categories/{id}

Deletes category where enabled.

GET/products

Lists products.

POST/products

Creates product.

PATCH/products/{id}

Updates product.

DELETE/products/{id}

Deletes product where enabled.

Product field	Type	Required	Description
category_id	integer	Optional	Category ID.
name	string	Required	Product name.
sku	string	Optional	SKU.
price	decimal	Required	Product price.
vat_rate	decimal	Optional	VAT rate.
image_url	string	Optional	Image URL.
stock_qty	integer	Optional	Stock quantity.
description	text	Optional	Product description.

Create category

POST /v2/categories
{
  "name": "Drinks",
  "sort_order": 1,
  "is_active": 1
}

Create product

POST /v2/products
{
  "category_id": 10,
  "name": "Latte",
  "sku": "LATTE-REG",
  "price": 3.50,
  "vat_rate": 20,
  "is_active": 1,
  "description": "Regular latte"
}

Product Options & Rules

Manage product-specific options and global option groups for POS and online ordering.

GET/product-option-groups

Lists product option groups.

POST/product-option-groups

Creates product option group.

GET/product-options

Lists product options.

POST/product-options

Creates product option.

GET/global-option-groups

Lists global option groups.

POST/global-option-groups

Creates global option group.

GET/global-option-items

Lists global option items.

POST/global-option-items

Creates global option item.

GET/global-option-assignments

Lists assignments.

POST/global-option-assignments

Creates assignment.

GET/product-option-rules

Alias for assignments/rules.

Field	Type	Description
name	string	Option or group name.
required	boolean	Require selection.
min_select / max_select	integer	Selection limits.
price_delta	decimal	Price change for selected item.
rules_json	object	Rule configuration.
scope / scope_id	enum/integer	Where a global option applies.

Create option group

POST /v2/product-option-groups
{
  "product_id": 42,
  "name": "Milk choice",
  "required": true,
  "min_select": 1,
  "max_select": 1,
  "sort_order": 1
}

Create option item

POST /v2/product-options
{
  "product_id": 42,
  "group_id": 9,
  "name": "Oat milk",
  "price_delta": 0.40,
  "sort_order": 1
}

Tables & Areas

Manage table maps, areas and table status for dine-in flows.

GET/table-areas

Lists table areas.

POST/table-areas

Creates table area.

GET/tables

Lists tables.

POST/tables

Creates table.

PATCH/tables/{id}

Updates table.

DELETE/tables/{id}

Deletes table where enabled.

Field	Type	Description
area_id	integer	Area ID.
name / label	string	Display name.
seats	integer	Seat count.
status	enum	available, occupied, reserved etc.
x,y,w,h,rotation	decimal/integer	Table-map coordinates.

Create table area

POST /v2/table-areas
{
  "name": "Main Floor",
  "label": "Main Floor",
  "sort_order": 1,
  "is_active": 1
}

Create table

POST /v2/tables
{
  "area_id": 1,
  "name": "T1",
  "label": "Table 1",
  "seats": 4,
  "status": "available",
  "x": 20,
  "y": 40,
  "w": 120,
  "h": 80
}

Cashiers, Registers & Staff

Manage POS cashiers, registers, POS staff and team members.

GET/cashiers

Lists cashiers.

POST/cashiers

Creates cashier.

GET/registers

Lists registers.

POST/registers

Creates register.

GET/pos-staffs

Lists POS staff.

POST/pos-staffs

Creates POS staff.

GET/team-members

Lists merchant team members.

POST/team-members

Creates team member.

Field	Type	Description
name	string	Staff/cashier name.
email / username	string	Login identifier.
password / new_password	string	Accepted on create/update but never returned.
role	enum	Role/register type.
permissions	object/array	Permission payload.
location_ids / till_ids	array	Allowed locations or tills.

Create cashier

POST /v2/cashiers
{
  "name": "Front Till",
  "email": "till@example.com",
  "phone": "01234567890",
  "role": "cashier",
  "is_active": 1,
  "permissions": ["orders:create", "refunds:view"],
  "location_ids": [1]
}

Create team member

POST /v2/team-members
{
  "name": "Manager User",
  "email": "manager@example.com",
  "password": "temporary-secret",
  "role": "manager",
  "status": "active",
  "permissions": ["neroconnect:view", "orders:view"]
}

Invoices

Create and manage merchant invoices and invoice line items.

GET/invoices

Lists invoices.

POST/invoices

Creates invoice.

GET/invoices/{id}

Retrieves invoice.

PATCH/invoices/{id}

Updates invoice.

GET/invoice-items

Lists invoice items.

POST/invoice-items

Creates invoice item.

Field	Type	Description
invoice_number	string	Invoice number.
invoice_to	string	Recipient name.
invoice_email	string	Recipient email.
currency_id	integer	Currency ID.
sub_total / total_amount	decimal	Amounts.
items_json	object/array	Line items payload.
due_date	date	Due date.
status	enum	draft, sent, paid etc.

Create invoice

POST /v2/invoices
{
  "invoice_number": "INV-1001",
  "invoice_to": "Jane Customer",
  "invoice_email": "jane@example.com",
  "currency_id": 1,
  "sub_total": 100.00,
  "total_vat": 20.00,
  "total_amount": 120.00,
  "due_date": "2026-05-31",
  "status": "sent",
  "items_json": [
    { "item_name": "Consulting", "qty": 1, "amount": 100.00 }
  ]
}

NeroPOS Orders

NeroPOS order APIs are separate from NeroWeb orders and generic store orders.

GET/neropos-orders

Lists NeroPOS orders.

POST/neropos-orders

Creates NeroPOS order.

GET/neropos-orders/{id}

Retrieves order.

PATCH/neropos-orders/{id}

Updates order.

GET/neropos-order-items

Lists order items.

POST/neropos-order-items

Creates order item.

GET/orders

Generic orders resource.

GET/store-orders

Read-only NeroPay Store orders.

Field	Type	Description
order_number / order_ref	string	Order reference.
status	enum	Order status.
fulfilment_type	enum	dine_in, takeaway, delivery etc.
payment_method / payment_status	enum	Payment fields.
customer_*	string	Customer details.
subtotal, total, tip_fee	decimal	Money fields.
location_id / table_id / staff_id	integer	Operational links.
meta_json	object	Extra order metadata.

Create NeroPOS order

POST /v2/neropos-orders
{
  "order_ref": "POS-1001",
  "status": "open",
  "fulfilment_type": "dine_in",
  "payment_method": "card",
  "payment_status": "pending",
  "customer_name": "Jane Customer",
  "subtotal": 10.00,
  "tax_fee": 2.00,
  "total": 12.00,
  "location_id": 1,
  "table_id": 3
}

Create order item

POST /v2/neropos-order-items
{
  "order_id": 1001,
  "product_id": 42,
  "name": "Latte",
  "qty": 2,
  "unit_price": 3.50,
  "total_price": 7.00,
  "options_json": [{"name":"Oat milk","price_delta":0.40}]
}

NeroPOS Payment Settings

Manage POS payment, tax, service fee, cashiers, tables and receipt defaults.

GET/payment-settings

Lists POS payment settings.

POST/payment-settings

Creates settings where no row exists.

GET/payment-settings/{id}

Retrieves settings.

PATCH/payment-settings/{id}

Updates settings.

Field	Type	Description
default_tax_fee	decimal	Default tax fee.
default_service_fee	decimal	Default service fee.
default_tip_fee	decimal	Default tip fee.
pos_mode / default_channel	enum	POS operating mode.
enable_tables / enable_cashiers	boolean	Feature toggles.
receipt_footer / receipt_logo_url	text/string	Receipt branding. Use `receipt_logo_url` for the logo image URL.
min_card_charge	decimal	Minimum card charge.

Update payment settings

PATCH /v2/payment-settings/1
{
  "default_tax_fee": 20,
  "default_service_fee": 0,
  "default_tip_fee": 0,
  "enable_tables": true,
  "enable_cashiers": true,
  "receipt_width": "80mm",
  "receipt_logo_url": "https://eu.neropay.app/assets/images/logoIcon/logo.png",
  "min_card_charge": 1.00
}

NeroWeb Settings

Configure online ordering storefront settings separately from POS resources.

GET/neroweb-settings

Lists NeroWeb settings.

POST/neroweb-settings

Creates settings.

GET/neroweb-settings/{id}

Retrieves settings.

PATCH/neroweb-settings/{id}

Updates settings.

Field	Type	Description
store_name	string	Online store name.
slug	string	Store slug.
is_active	boolean	Enable store.
disable_delivery / disable_collect	boolean	Fulfilment toggles.
enable_card / enable_cash	boolean	Payment toggles.
working_hours_json	object	Working hours.
delivery_bands_json	object	Delivery pricing/areas.
theme_json	object	Brand/theme settings, including `logo_url`.

Update NeroWeb settings

PATCH /v2/neroweb-settings/1
{
  "store_name": "Demo Store",
  "slug": "demo-store",
  "is_active": true,
  "disable_delivery": false,
  "disable_collect": false,
  "enable_card": true,
  "working_hours_json": {
    "monday": [{"from":"09:00","to":"17:00"}]
  },
  "theme_json": {
    "logo_url": "https://eu.neropay.app/assets/images/logoIcon/logo.png"
  }
}

NeroWeb Pages

Manage public pages used by the NeroWeb storefront builder.

GET/neroweb-pages

Lists pages.

POST/neroweb-pages

Creates page.

GET/neroweb-pages/{id}

Retrieves page.

PATCH/neroweb-pages/{id}

Updates page.

GET/nerowebpages

Legacy alias for pages.

Field	Type	Description
title	string	Page title.
slug	string	URL slug.
page_type	enum	home, content, legal etc.
is_home / is_published / show_in_nav	boolean	Page flags.
nav_label / nav_order	string/integer	Navigation settings.
html_content / content / css_content	text	Page content.
builder_json	object	Builder state.
meta_title / meta_description	string/text	SEO metadata.

Create NeroWeb page

POST /v2/neroweb-pages
{
  "title": "About us",
  "slug": "about",
  "page_type": "content",
  "is_published": true,
  "show_in_nav": true,
  "nav_label": "About",
  "html_content": "<h1>About us</h1>",
  "meta_title": "About Demo Store"
}

NeroWeb Orders

NeroWeb orders are separate from NeroPOS orders and store orders.

GET/neroweb-orders

Lists NeroWeb orders.

POST/neroweb-orders

Creates NeroWeb order.

GET/neroweb-orders/{id}

Retrieves order.

PATCH/neroweb-orders/{id}

Updates order.

GET/neroweb-order-items

Lists order items.

POST/neroweb-order-items

Creates order item.

Field	Type	Description
order_ref	string	Order reference.
status	enum	Order status.
fulfilment_type	enum	delivery, collect etc.
payment_method / payment_status	enum	Payment fields.
subtotal_pence / total_pence	integer/decimal	Money fields.
customer_name / email / phone	string	Customer fields.
meta_json	object	Extra metadata.

Create NeroWeb order

POST /v2/neroweb-orders
{
  "order_ref": "WEB-1001",
  "status": "pending",
  "fulfilment_type": "delivery",
  "payment_method": "card",
  "payment_status": "pending",
  "customer_name": "Jane Customer",
  "customer_email": "jane@example.com",
  "subtotal_pence": 1000,
  "delivery_fee_pence": 250,
  "total_pence": 1250
}

Booking Settings

Booking settings are separate from booking transactions and should appear under the Booking menu.

GET/booking-settings

Lists booking settings.

POST/booking-settings

Creates booking settings.

GET/booking-settings/{id}

Retrieves booking settings.

PATCH/booking-settings/{id}

Updates booking settings.

Field	Type	Description
booking_company_name	string	Booking brand/company name.
booking_type	enum	Booking mode/type.
weekly_hours	object	Weekly opening hours.
auto_approve_booking	boolean	Auto approve bookings.
slot_duration	integer	Minutes per slot.
max_bookings_per_slot / max_guests	integer	Capacity.
services	object/array	Bookable services.
holiday_days	array	Closed dates.
staff_enabled / staff	boolean/object	Staff booking assignment.

Update booking settings

PATCH /v2/booking-settings/1
{
  "booking_company_name": "Demo Booking",
  "booking_type": "appointment",
  "slot_duration": 30,
  "max_bookings_per_slot": 1,
  "max_guests": 4,
  "auto_approve_booking": true,
  "weekly_hours": {
    "monday": [{"from":"09:00","to":"17:00"}]
  },
  "services": [
    {"name":"Consultation","duration":30,"price":25.00}
  ]
}

Bookings

Create and manage booking transactions.

GET/bookings

Lists bookings.

POST/bookings

Creates booking.

GET/bookings/{id}

Retrieves booking.

PATCH/bookings/{id}

Updates booking.

Field	Type	Required	Description
booking_date	date	Required	Booking date.
booking_time	time	Required	Booking time.
guest_count	integer	Optional	Guests.
service	string	Optional	Service name.
amount	decimal	Optional	Booking amount.
staff_id / staff_name	integer/string	Optional	Staff assignment.
location_id	integer	Optional	Location.
customer_name / phone / email	string	Required	Customer details.
customer_note	text	Optional	Customer note.
status	enum	Optional	pending, confirmed, cancelled etc.

Create booking

POST /v2/bookings
{
  "booking_date": "2026-05-10",
  "booking_time": "14:00",
  "guest_count": 2,
  "service": "Consultation",
  "amount": 25.00,
  "customer_name": "Jane Customer",
  "customer_phone": "+447700900000",
  "customer_email": "jane@example.com",
  "status": "pending"
}

KYC / Identity API

Identity API is not only for NeroConnect. Direct merchants can also use it to create verification links and read verification sessions.

POST/identity/verification-links

Creates a document verification link.

GET/identity/verification-sessions

Lists verification sessions.

GET/identity/verification-sessions/{id}

Retrieves one verification session.

Field	Type	Required	Description
type	enum	Optional	document or supported verification type.
return_url	string	Optional	Where the user should return after verification.
first_name / last_name	string	Optional	Prefill name if known.
country	enum	Optional	ISO country code.
metadata	object	Optional	Developer metadata.

NeroPay should not expose the underlying verification provider in your customer-facing copy. Use the returned short_url or verification_url in your own dashboard.

Create verification link

POST /v2/identity/verification-links
{
  "type": "document",
  "return_url": "https://platform.example.com/kyc/return",
  "first_name": "Jane",
  "last_name": "Merchant",
  "country": "GB",
  "metadata": {
    "user_id": "user_1001"
  }
}

List verification sessions response

{
  "success": true,
  "data": {
    "account_id": "NPEE4E742AB2_6165",
    "sessions": [
      {
        "id": 54484,
        "verification_id": "vs_1TJS0MLWX9o5cjig2zgdWrN7",
        "status": "requires_input",
        "type": "document",
        "verification_url": "https://verify.example/start/...",
        "short_url": "https://verify.neropay.app/7d06xoyeop3nv",
        "first_name": null,
        "last_name": null,
        "country": null,
        "document_type": null,
        "created_at": "2026-04-07T05:16:50.000000Z",
        "updated_at": "2026-04-07T05:16:50.000000Z"
      },
      {
        "id": 49138,
        "verification_id": "vs_1SSkwHLWX9o5cjig03xCd6c9",
        "status": "verified",
        "type": "document",
        "verification_url": null,
        "short_url": "https://verify.neropay.app/sarbz424yicb3",
        "first_name": "HASAN",
        "last_name": "BOZKUS",
        "country": "GB",
        "document_type": "driving_license",
        "created_at": "2025-11-12T20:46:49.000000Z",
        "updated_at": "2026-03-30T21:04:11.000000Z"
      }
    ]
  }
}

Compliance API

Compliance APIs let merchants or platforms read requested documents and submit evidence back to NeroPay.

GET/compliance/requests

Lists compliance document requests.

GET/compliance/requests/{id}

Retrieves one compliance request.

POST/compliance/requests/{id}/documents

Uploads requested compliance documents.

Field	Type	Required	Description
document_file	file	Required	Requested file.
document_type	string	Optional	Type requested by staff/compliance.
notes	text	Optional	Merchant or platform notes.
metadata	object	Optional	Optional developer metadata.

Compliance is not NeroConnect-only. If a direct merchant uses API v2, the same endpoints can be used for document request fulfilment. Webhooks notify document requested/submitted/approved/rejected.

List compliance requests response

{
  "success": true,
  "data": {
    "account_id": "NPEE4E742AB2_6165",
    "requests": []
  },
  "meta": {
    "pagination": {
      "current_page": 1,
      "per_page": 25,
      "total": 0,
      "last_page": 1
    }
  }
}

Submit compliance document

POST /v2/compliance/requests/123/documents
Content-Type: multipart/form-data

document_file=@proof-of-address.pdf
notes=Latest proof of address attached.
metadata[case_reference]=CASE-1001

Support Tickets

White-label support APIs allow a platform to create tickets for NeroPay staff while keeping the platform as the customer-facing brand.

GET/support/tickets

Lists tickets.

POST/support/tickets

Creates ticket.

GET/support/tickets/{id}

Retrieves ticket.

POST/support/tickets/{id}/messages

Adds ticket message.

Field	Type	Required	Description
subject	string	Required	Ticket subject.
message	text	Required	Initial message.
priority	enum	Optional	low, normal, high, urgent.
category	string	Optional	Support category.
attachments[]	file	Optional	Optional files where supported.

When NeroPay answers a ticket, your platform can receive support.ticket_updated and support.message_created webhooks and display the answer in your own UI.

Create support ticket

POST /v2/support/tickets
{
  "subject": "Customer payout question",
  "message": "The connected merchant needs help with a payout.",
  "priority": "normal",
  "category": "payouts"
}

Ticket response

{
  "success": true,
  "data": {
    "ticket": {
      "id": 501,
      "subject": "Customer payout question",
      "status": "open",
      "priority": "normal",
      "created_at": "2026-04-28T18:00:00.000000Z"
    }
  }
}

Webhooks

Use webhooks for account updates, KYC, compliance, proof, reserve release and support events.

GET/webhooks

Lists configured endpoints.

GET/webhook-deliveries

Lists delivery attempts.

transaction.proof_requestedtransaction.proof_submittedtransaction.proof_approvedtransaction.proof_rejectedpayout.proof_requestedtransfer.proof_requestedbalance.reserve_releasedcompliance.document_requestedcompliance.document_submittedcompliance.document_approvedcompliance.document_rejectedkyc.pendingkyc.verifiedkyc.rejectedaccount.updateaccount.updatedconnected_account.createdconnected_account.updatedsupport.ticket_createdsupport.ticket_updatedsupport.message_created

Field	Type	Description
id	string	Webhook event ID.
type	enum	Event type.
created_at	datetime	Event creation time.
account	object	Merchant or connected account payload.
data	object	Event-specific payload.
signature	string	Use your endpoint signing secret where configured.

If the platform handles email/SMS, NeroPay skips delegated merchant-facing messages and publishes webhooks so the platform can send branded communication.

Webhook payload

{
  "id": "evt_np_01HX...",
  "type": "transaction.proof_requested",
  "created_at": "2026-04-28T18:00:00.000000Z",
  "account": {
    "id": "NPEE4E742AB2_6165",
    "business_company_name": "Demo Connected Merchant Ltd"
  },
  "data": {
    "transaction": {
      "id": 5663230,
      "amount": 5000.00,
      "currency": "GBP",
      "is_reserve": true,
      "reserve_amount": 5000.00
    },
    "proof_request": {
      "id": 925,
      "status": "requested"
    }
  }
}

List deliveries

GET /v2/webhook-deliveries?status=failed&per_page=25

Sandbox

Sandbox write endpoints under /sandbox return realistic JSON and do not create live payment, terminal, payout or local records.

POST/sandbox/hosted-payments

Dry-run hosted payment.

POST/sandbox/payment-intents

Dry-run payment intent.

POST/sandbox/terminal/payments

Dry-run terminal payment.

POST/sandbox/payment-links

Dry-run payment link.

POST/sandbox/terminal/locations

Dry-run terminal location.

POST/sandbox/terminal/readers

Dry-run reader registration.

POST/sandbox/bank-accounts

Dry-run bank account.

POST/sandbox/payouts

Dry-run payout.

PATCH/sandbox/payout-schedule

Dry-run schedule update.

POST/sandbox/resources/{resource}

Dry-run resource create.

Sandbox is designed for API clients and Postman tests. Use live endpoints only when you want real records/actions.

Sandbox payment intent

POST /v2/sandbox/payment-intents
{
  "amount": 15.99,
  "currency": "GBP",
  "description": "Sandbox payment intent",
  "reference": "SANDBOX-PI-1001"
}

Sandbox response

{
  "success": true,
  "data": {
    "sandbox": true,
    "payment": {
      "status": "pending",
      "amount": 15.99,
      "currency": "GBP"
    }
  }
}

Resource Reference

API v2 exposes explicit controller endpoints plus direct resource aliases. Resources are grouped by product area in this documentation; they are not all hidden under NeroPOS.

Core

accountconnected-accountsbalancesbalanceapi-logs

Payments

hosted-paymentspaymentspayment-intentspayment-linkstransactionstransaction proof

Money Movement

wallet-transactionspayoutspayout-scheduletransfer-scheduledisputesloans

NeroDisburse

bank-accountsnerodisburse/bank-accountsnerodisburse/payoutsnerodisburse/paymentsnerodisburse-bank-accountsnerodisburse-payoutsnerodisburse-payments

Terminal

terminal/paymentslocationsterminal/locationsreadersterminal/readersdevices

NeroCard

nerocardsnerocardholdersnerocard-transactions

NeroPOS

customerscategoriesproductsproduct-option-groupsproduct-optionsglobal-option-groupsglobal-option-itemsglobal-option-assignmentsproduct-option-rulescashiersregisterspos-staffsteam-memberstablestable-areasinvoicesinvoice-itemsordersneropos-ordersneropos-order-itemspayment-settings

NeroWeb

neroweb-settingsneroweb-pagesnerowebpagesneroweb-ordersneroweb-order-itemsstore-orders

Bookings

booking-settingsbookings

Risk & Ops

identity/verification-linksidentity/verification-sessionscompliance/requestssupport/ticketswebhookswebhook-deliveries

Direct aliases such as /v2/disputes, /v2/bank-accounts, /v2/neroweb-orders, /v2/nerocard-transactions and /v2/bookings should not return route-not-found when the v2 route patch is deployed and route cache is cleared.

Generic resource pattern

GET    /v2/{resource}
POST   /v2/{resource}
GET    /v2/{resource}/{id}
PATCH  /v2/{resource}/{id}
DELETE /v2/{resource}/{id}

# Explicit namespace also works:
GET    /v2/resources/{resource}
POST   /v2/resources/{resource}
GET    /v2/resources/{resource}/{id}
PATCH  /v2/resources/{resource}/{id}
DELETE /v2/resources/{resource}/{id}