Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page shows the request payload for NGN (Nigerian Naira) Payoutprocessing GBP Payout to Local GBP Beneficiaries

Panel
bgColor#FFC400

Request Body

Expand
titleRequest Payload for NGN (Nigerian Naira)GBP
Code Block
languagejson
{
    "currencyCode": "NGNGBP",
    "beneficiaryAccountName": "ACCOUNTBOLLY HOLDER NAMEGROUP",
    "beneficiaryAccountNumber": "011234567800008245", // using test account
    "amount": 1200,
    "narration": "Single Payout NGNGBP example",
    "paymentMethodType": "BankCodeSortCode",
    "paymentMethodValue": "999998040691", // using test value
    "tenantReference": "{{$randomInt}}",
    "beneficiaryAddress": "8916 Str Ave, Woodhaven, United Kingdom",
    "nameEnquiryRefbeneficiaryCountryIso": null,
    "beneficiaryKYCLevel": null,
    "beneficiaryBankVerificationNumber": null,
    "beneficiaryCity": null,
    "beneficiaryState": null,
    "beneficiaryZIP": null,
    "beneficiaryCountryIso": null
"GB"
}

Element

Description

Type

Example

Required

currencyCode

Currency Code for the transaction which is NGN

String, 3 digits

NGN

GBP

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

8 digits, no special characters, no space, no alphanumeric

0123456789

01234567

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”

“SortCode”

String | ENUM

“BankCode”

“SortCode”

Yes

paymentMethodValue

This is the

value/code

sortcode of the beneficiary

bank. This can be retrieved from bank list endpoint (Beneficiary bank code)

account bank, your beneficiary must supply this

String, all integers, 6 digits

000004

040004

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

beneficiaryKYCLevel

 

 

 

No

beneficiaryBankVerificationNumber

BVN of the beneficiary account number, this can be retrieved using name enquiry

String, 11 digits

33000000032

No

This can be retrieve from nameEnquiry as “sessionID”

string

"sessionID": "999328240122180450359330640488",

No

beneficiaryCountryIso

Country of the beneficiary:

NG

GB

string

Iso2:

NG

GB

Yes

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@1256f
sortmodified
showSpacefalse
reversetrue
typepage
labelskb-how-to-article
cqllabel = "kb-how-to-article" and type = "page" and space = "LAD"