| Rail | Description | Settlement | Limit |
|---|---|---|---|
NG_BANK_PAYOUT | Nigeria local bank payout. Country-dependent availability. Real-time cut-off. | Real-time to 48 hours | ₦5,000,000 |
For details on rail selection, see Payment rail reference.
When creating a beneficiary identity for NGN payments, provide the following fields. See Create and manage identities for the API workflow.
The required fields depend on whether the beneficiary is a business or an individual.
Applies to B2B, B2B2B, and C2B2B use cases. Submit a business identity.
| Field | Required | Type | Constraints |
|---|---|---|---|
businessName | Required | STRING | 1–140 characters. |
address.streetAddress | Required | ARRAY of STRING | Each item 1–70 characters. |
address.city | Required | STRING | 1–140 characters. |
address.stateOrProvince | Required | STRING | 1–140 characters. |
address.postalCode | Required | STRING | 3–15 characters. |
address.country | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code. |
phone | Required | STRING | 8–16 characters. Pattern: ^\+[1-9]\d+$ (E.164 format). |
registration | Required | ARRAY of OBJECT | Each item: number (3–35 characters) and type (one of INCORPORATION_CERTIFICATE, TAX_ID). At least one registration entry is required. |
incorporationCountry | Required | STRING | Two-letter ISO 3166-1 alpha-2 code of the country where the business was incorporated. |
Applies to B2C, B2B2C, and C2B2C use cases. Submit an individual identity.
| Field | Required | Type | Constraints |
|---|---|---|---|
firstName | Required | STRING | 1–140 characters. |
lastName | Required | STRING | 1–140 characters. |
address.streetAddress | Required | ARRAY of STRING | Each item 1–70 characters. |
address.city | Required | STRING | 1–140 characters. |
address.stateOrProvince | Required | STRING | 1–140 characters. |
address.postalCode | Required | STRING | 3–15 characters. |
address.country | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code. |
phone | Required | STRING | 8–16 characters. Pattern: ^\+[1-9]\d+$ (E.164 format). |
identityDocuments | Required | ARRAY of OBJECT | Each item: idNumber (3–35 characters) and idType (one of ALIEN_REGISTRATION, CUSTOMER_ID, DRIVERS_LICENSE, EMPLOYEE_ID, NATIONAL_ID_NUMBER, PASSPORT, SSN, TAX_ID). |
citizenship | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code of the individual's nationality. |
gender | Required | ENUM | One of: MALE, FEMALE, OTHER. |
When creating a financial instrument for NGN payouts, set financialInstrumentType: NG_BANK_PAYOUT and currency: NGN. Provide the following fields in the ngBankPayout payment rail object. See Create and manage financial instruments for the API workflow.
| Field | Required | Type | Constraints |
|---|---|---|---|
bankName | Required | STRING | 2–140 characters. |
bankCode | Required | STRING | 1–50 characters. The beneficiary's bank code. |
accountNumber | Required | STRING | 4–21 characters. The beneficiary's bank account number. |
When creating an originator identity for NGN payments, provide the following fields. The required fields depend on whether the originator is a business or an individual.
Applies to B2B, B2B2B, B2B2C, and B2C use cases. Submit a business identity.
| Field | Required | Type | Constraints |
|---|---|---|---|
businessName | Required | STRING | 1–140 characters. |
address.streetAddress | Required | ARRAY of STRING | Each item 1–70 characters. |
address.city | Required | STRING | 1–140 characters. |
address.stateOrProvince | Required | STRING | 1–140 characters. |
address.postalCode | Required | STRING | 3–15 characters. |
address.country | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code. |
phone | Required | STRING | 8–16 characters. Pattern: ^\+[1-9]\d+$ (E.164 format). |
registration | Required | ARRAY of OBJECT | Each item: number (3–35 characters) and type (one of INCORPORATION_CERTIFICATE, TAX_ID). At least one registration entry is required. |
Applies to C2B2B and C2B2C use cases. Submit an individual identity.
| Field | Required | Type | Constraints |
|---|---|---|---|
firstName | Required | STRING | 1–140 characters. |
lastName | Required | STRING | 1–140 characters. |
countryOfBirth | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code. |
address.streetAddress | Required | ARRAY of STRING | Each item 1–70 characters. |
address.city | Required | STRING | 1–140 characters. |
address.stateOrProvince | Required | STRING | 1–140 characters. |
address.postalCode | Required | STRING | 3–15 characters. |
address.country | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code. |
phone | Required | STRING | 8–16 characters. Pattern: ^\+[1-9]\d+$ (E.164 format). |
citizenship | Required | STRING | Two-letter ISO 3166-1 alpha-2 country code. |
When creating a payment, provide the following fields. See Create a payment for the API workflow.
| Field | Required | Type | Constraints | |
|---|---|---|---|---|
purposeCode | Required | ENUM | See Purpose of payment codes below. | |
paymentMemo | Optional | STRING | 0–16 characters. | |
paymentMemo | Payment memo | Optional | STRING | 0–16 chars |
| Code | Description |
|---|---|
ALLW | Allowance |
BONU | Bonus payment |
CISC | Construction and installation services |
COMM | Commission |
DEPT | Deposit |
DOFI | Deposits with or from offshore financial institutions |
EDSC | Education services |
EDUC | Education |
ENGS | Architectural, engineering, and other technical services |
FAMI | Family maintenance |
FEES | Payment of fees |
GDDS | Purchase or sale of goods |
GDSV | Purchase or sale of goods and services |
GIFT | Gift |
GSPM | Goods for processing and manufacturing services |
GSST | Goods and services by short-term workers |
GSTR | Goods and services by travellers |
HLTC | Home health care |
INTC | Intra-company payment |
INTE | Interest |
INVS | Investment and securities |
IVPT | Invoice payment |
MACH | Payment for machinery, non-customized packaged software, or transport equipment |
MDCS | Medical services |
MFGD | Payment for manufactured goods |
MMFA | Payment for miscellaneous manufactured articles |
MP2P | Mobile peer-to-peer payment |
MRSC | Maintenance and repair services |
OCDM | Order cheque domestic |
OCFG | Order cheque foreign |
OTHR | Other |
PAYR | Payroll |
PSFR | Passenger fare |
REAB | Real estate abroad |
RELG | Rental lease general |
SALA | Salary payment |
SCVE | Purchase or sale of services |
STDY | Study |
SUPP | Supplier payment |
TLLT | Term loans, long-term |
TLST | Term loans, short-term |
TRAD | Trade services |
VIAC | Visa application charges |
For the exact fields required for your specific use case and payment rail, use the Payload Schema Utility.