Skip to main content
POST
NGN Collection Application

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer<int64>
required

Business ID obtained from the backend; it must match the URL currency

orderId
string
required

Unique merchant order ID, up to 48 characters

Maximum string length: 48
amount
string
required

Transaction amount in NGN; subject to the merchant backend business configuration. The common request format accepts up to 4 decimal places; the channel processes 2 decimal places

Pattern: ^((([1-9]\d*)(\.\d{1,4})?)|(0\.(?!0+$)\d{1,4}))$
sign
string
required

Signature

payType
string

Payment type configured in the merchant backend

inBankCode
string

Collection payment code configured in the merchant backend

name
string

Payer name

phone
string

Payer phone number

Maximum string length: 20
email
string<email>

Payer email; the channel uses a default email when omitted

callBackUrl
string<uri>

Redirect URL after successful payment

callBackFailUrl
string<uri>

Redirect URL after failed payment

notifyUrl
string<uri>

Asynchronous notification URL

subject
string

Transaction title, product name, or payment reason

body
string

Detailed remark

partnerUserId
string

Unique user identifier

Maximum string length: 64
Pattern: ^[a-zA-Z0-9\-~!@#$%&*()_]+$

Response

200 - application/json

Success

status
string

API status: 1 normal, 0 exception

error
string

Error code

msg
string

Message

data
object
Last modified on September 14, 2026