NeroPay Docs
API & Integrations

Complete API Endpoint Map

Endpoint map

Complete API Endpoint Map

A quick reference for all documented NeroPay API v2 endpoints.

Endpoint mapGETPOST

Complete endpoint map

MethodEndpointPurpose
GET/healthAPI route health check.
GET/accountAuthenticated merchant profile.
GET/balancesBalances for merchant or connected account.
GET/connected-accountsList platform connected merchants.
POST/connected-accountsCreate connected merchant.
POST/payment-intentsCreate payment intent.
POST/paymentsCreate hosted checkout payment.
POST/keyed-paymentsCreate keyed payment.
POST/split-paymentsCreate split payment.
POST/terminal/paymentsCreate terminal payment.
GET/transactionsList transactions.
GET/transactions/{id}Retrieve transaction.
POST/transactions/{id}/refundRefund transaction.
POST/transactions/{id}/cancelCancel transaction.
GET/payment-linksList LinkPay links.
POST/payment-linksCreate LinkPay link.
GET/bank-accountsList bank accounts.
POST/bank-accountsCreate bank account.
POST/nerodisburse/bank-accountsCreate NeroDisburse bank account.
GET/payoutsList payouts.
POST/payoutsCreate payout.
GET/nerodisburse/payoutsList NeroDisburse payouts.
POST/nerodisburse/payoutsCreate NeroDisburse payout.
GET/transfer-scheduleRead transfer schedule.
PATCH/transfer-scheduleUpdate transfer schedule.
GET/locationsList terminal locations.
POST/locationsCreate terminal location.
GET/readersList terminal readers.
POST/readersRegister reader.
DELETE/readers/{id}Delete reader.
GET/customersList customers.
POST/customersCreate customer.
GET/categoriesList categories.
POST/categoriesCreate category.
DELETE/categories/{id}Delete category.
GET/productsList products.
POST/productsCreate product.
DELETE/products/{id}Delete product.
GET/product-option-groupsList product option groups.
POST/product-option-groupsCreate product option group.
GET/global-option-itemsList global option items.
POST/global-option-itemsCreate global option item.
GET/tablesList tables.
POST/tablesCreate table.
DELETE/tables/{id}Delete table.
GET/registersList registers.
POST/registersCreate register.
DELETE/registers/{id}Delete register.
GET/pos-staffsList POS staff.
POST/pos-staffsCreate POS staff.
GET/neropos-ordersList NeroPOS orders.
GET/neroweb-ordersList NeroWeb orders.
GET/booking-settingsRead booking settings.
POST/bookingsCreate booking.
GET/bookingsList bookings.
POST/invoicesCreate invoice.
GET/invoicesList invoices.
GET/nerowebpagesList NeroWeb pages.
GET/neroweb-settingsList NeroWeb settings.
GET/disputesList disputes.
GET/loansList loans.
GET/nerocardsList NeroCards.
GET/webhooksList webhooks.
GET/webhook-deliveriesList webhook deliveries.

Pagination

List endpoints may return a meta object with current_page, per_page, total and last_page. Use page and limit query parameters where available.

{
  "success": true,
  "data": {
    "data": [
      {
        "id": 1,
        "status": "active"
      }
    ],
    "meta": {
      "current_page": 1,
      "per_page": 25,
      "total": 100,
      "last_page": 4
    }
  }
}