UK Beneficiary

Before making a payment to a UK bank account, you are to add a beneficiary. Note that we can payout Pounds or Euros to UK accounts.

Here is a sample request to add a Pounds UK beneficiary:

cURL

curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
    "reference": "80f29319-bb88-40e8-8854-e7fed7d07544",
   "callbackUrl": "https://webhook.site/38a9e65e-3388-4399-89d4-3ceafa817111",
    "country": "GB",
    "currency": "GBP",
    "customerEmail": "roy@email.com",
    "destination": {
        "accountNumber": "55555575",
        "accountName": "Helen Griffith",
        "sortCode": "09-87-69",
        "type": "DOMESTIC_GBP",
        "sender": {
            "type": "INDIVIDUAL",
            "accountName": "Jane Doe",
            "country": "NG",
            "city": "Ikeja",
            "address": "3 Opebi road",
            "postCode": "23456543",
        },
        "remittancePurpose": "TRAVEL",
        "beneficiary": {
            "type": "INDIVIDUAL",
            "country": "GB",
            "city": "lawmen",
            "postCode": "2343",
            "address": "2 huddington road"
        }
    }
}'

The parameters for adding beneficiary for Pounds UK beneficiary are:

Parameter	Description	Required
accountNumber	Account number of the beneficiary.	✅
accountName	Name of the beneficiary's account. `Individual senders must provide first and last name`	✅
sortCode	Sort code of the beneficiary's account. `It must be in the format XX-XX-XX e.g 09-87-69`	✅
type	Payment type must be `DOMESTIC_GBP`.	✅
remittancePurpose	Purpose of the remittance. `See accepted remittance purposes` `here` (opens in a new tab)	✅
sender	Sender details. `See Sender Parameters below.`	✅
beneficiary	Beneficiary details. `See Beneficiary Parameters below.`	✅

Sender Parameters

Parameter	Description	Required
sender[type]	Type of sender (BUSINESS or INDIVIDUAL).	✅
sender[accountName]	Name of the sender's account. `Individual senders must provide first and last name`	✅
sender[country]	Sender's country.	✅
sender[city]	Sender's city.	✅
sender[address]	Sender's address.	✅
sender[postCode]	Sender's postcode.	✅
sender[businessRegistrationNumber]	Business registration number `Only if sender is BUSINESS`.

Beneficiary Parameters

Parameter	Description	Required
beneficiary[type]	Type of beneficiary (BUSINESS or INDIVIDUAL).	✅
beneficiary[country]	Beneficiary's country.	✅
beneficiary[city]	Beneficiary's city.	✅
beneficiary[address]	Beneficiary's address.	✅
beneficiary[postCode]	Beneficiary's postcode.	✅

Kenya Beneficiary UK Beneficiary (EUR)