NGN Payout

This page shows the request payload for NGN (Nigerian Naira) Payout

Request Body

{
    "currencyCode": "NGN",
    "beneficiaryAccountName": "ACCOUNT HOLDER NAME",
    "beneficiaryAccountNumber": "0112345678", // using test account
    "amount": 1200,
    "narration": "Single Payout NGN example",
    "paymentMethodType": "BankCode",
    "paymentMethodValue": "999998", // using test value
    "tenantReference": "{{$randomInt}}",
    "beneficiaryAddress": "8916 Str Ave, Woodhaven, United Kingdom",
    "nameEnquiryRef": null,
    "beneficiaryKYCLevel": null,
    "beneficiaryBankVerificationNumber": null,
    "beneficiaryCity": null,
    "beneficiaryState": null,
    "beneficiaryZIP": null,
    "beneficiaryCountryIso": null
}

Element	Description	Type	Example	Required
`currencyCode`	Currency Code for the transaction which is NGN	String, 3 digits	NGN	Yes
`beneficiaryAccountName`	Full name of the beneficiary account, this can be retrieved from name enquiry endpoint	string	Account Holder	Yes
`beneficiaryAccountNumber`	Account Number of beneficiary	String \| 10 digits, no special characters, no space, no alphanumeric	0123456789	Yes
`amount`	Transaction Amount to be sent to beneficiary	Float \| Integer, Must be greater or equal to 1.00, 2 Decimal places	100, 100.20	Yes
`narration`	Description for transaction, which user will see	String, maxlength: 100 character	E.g “Payment for lunch”	Yes
`paymentMethodType`	The payment method type supported for this transaction is “BankCode”	String \| ENUM	“BankCode”	Yes
`paymentMethodValue`	This is the value/code of the beneficiary bank. This can be retrieved from bank list endpoint (Beneficiary bank code)	String, all integers, 6 digits	000004	Yes
`tenantReference`	This is your reference linked to the transaction, this will be returned with a prefix	string	If you pass “TYGHR”, it will be returned as “RTDF-TYGHR”, just as an example	Yes
`beneficiaryAddress`	Address of the beneficiary	string		No
`nameEnquiryRef`	This can be retrieve from nameEnquiry as “sessionID”	string	"sessionID": "999328240122180450359330640488",	No
`beneficiaryKYCLevel`				No
`beneficiaryBankVerificationNumber`	BVN of the beneficiary account number, this can be retrieved using name enquiry	String, 11 digits	33000000032	No
`beneficiaryCountryIso`	Country of the beneficiary: NG	string	Iso2: NG	Yes

API DOCUMENTATION

NGN Payout

Related articles