Request Payload for GBP Payout

This page shows the request payload for processing GBP Payout to Local GBP Beneficiaries

Request Body

{
    "currencyCode": "GBP",
    "beneficiaryAccountName": "BOLLY GROUP",
    "beneficiaryAccountNumber": "00008245", // using test account
    "amount": 1200,
    "narration": "Single Payout GBP example",
    "paymentMethodType": "SortCode",
    "paymentMethodValue": "040691", // using test value
    "tenantReference": "{{$randomInt}}",
    "beneficiaryAddress": "8916 Str Ave, Woodhaven, United Kingdom",
    "beneficiaryCountryIso": "GB"
}

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	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 and unique for each transaction	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

API DOCUMENTATION

Request Payload for GBP Payout

Related articles