Request Payload for GBP Payout

Element

Description

Type

Example

Required

currencyCode

Currency Code for the transaction which is NGN

String, 3 digits

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 | 8 digits, no special characters, no space, no alphanumeric

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 “SortCode”

String | ENUM

“SortCode”

Yes

paymentMethodValue

This is the sortcode of the beneficiary account bank, your beneficiary must supply this

String, all integers, 6 digits

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

beneficiaryCountryIso

Country of the beneficiary: GB

string

Iso2: GB

Yes