Skip to main content
POST
Record business collection payment
Records a payment collection from an external payer, crediting the merchant’s NGN wallet.

Environment Notes

  • Production-key payments credit the live merchant wallet.
  • Test-key payments credit only the sandbox merchant wallet.

Authorizations

x-api-key
string
header
required

Merchant API Key (e.g., nexa-prod-... or nexa-test-...)

Headers

x-business-env
enum<string>
default:prod

Target environment selector (live production vs. simulated sandbox).

Available options:
prod,
test

Body

application/json
businessId
string
required

Unique business ID.

amount
number
required

The transaction amount.

externalPayerName
string

The name of the payer.

payerName
string

Alternative name parameter for the payer.

externalPayerId
string
externalPayerEmail
string
payerEmail
string
externalPayerPhone
string
payerPhone
string
payerMetadata
object
serviceType
string
description
string

Response

Payment successfully recorded.