Documentation
Beneficiaries
Canada Beneficiary

Canada Beneficiary

Before making a payment to a Canada bank account, you must add the account as a beneficiary. Note that payments to Canada beneficiaries are via bank transfer.

Below is a sample request for creating a Canada beneficiary:

cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
    "reference": "<samplereference>",
    "country": "CA",
    "currency": "CAD",
    "destination": {
        "type": "BANK",
        "accountName": "Jane Doe",
        "accountNumber": "1234567",
        "transitCode": "12345",
        "bankCode": 4715,
        "remittancePurpose": "FAMILY_SUPPORT",
        "beneficiary": {
            "type": "INDIVIDUAL"
        },
        "sender": {
            "type": "INDIVIDUAL",
            "accountName": "John Doe",
            "postCode": "101234",
            "dateOfBirth": "2001-01-01",
            "country": "NG"
        }
    }
}'

The parameters for adding Canada bank account beneficiaries are:

ParameterDescriptionRequired
typeThe type of destination. Must be "BANK".
accountNameName of the beneficiary's account.
A space separated first and last name must be provided for individual beneficiaries e.g Marie Dubois
accountNumberThe beneficiary's Account number.
remittancePurposePurpose of the remittance.
See accepted remittance purposes here (opens in a new tab)
bankCodeCode of the receiving bank
See accepted bankCodes here (opens in a new tab)
transitCodeCode of the receiving bank branch
senderSender information varies depending on type. Sender type can either be BUSINESS or INDIVIDUAL.
beneficiaryBeneficiary information.

Sender Parameters (Business)

ParameterDescriptionRequired
sender[type]Type of sender. Must be "BUSINESS".
sender[accountName]Sender's accountName
sender[country]Sender's country
sender[postCode]Sender's address post code
sender[businessRegistrationNumber]Sender's business registration number

Sender Parameters (Individual)

ParameterDescriptionRequired
sender[type]Type of sender. Must be "INDIVIDUAL"
sender[accountName]Sender's accountName
sender[postCode]Sender's address post code
sender[dateOfBirth]Sender's date of birth
sender[country]Sender's country

Beneficiary Parameters

ParameterDescriptionRequired
beneficiary[type]Type of beneficiary, either "BUSINESS" or "INDIVIDUAL"