South Africa Beneficiary
Before making a payment to a South African bank account, you must add the account as a beneficiary. Note that payments to South African beneficiaries are via bank transfer.
Below is a sample request for creating a South African beneficiary:
cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
"reference": "<samplereference>",
"country": "ZA",
"currency": "ZAR",
"destination": {
"type": "BANK",
"accountName": "Sarah Johnson",
"accountNumber": "5555666677",
"remittancePurpose": "GIFT_AND_DONATION",
"bankCode": 3053,
"beneficiary": {
"type": "INDIVIDUAL",
"phoneNumber": "+27123456789"
},
"sender": {
"type": "INDIVIDUAL",
"accountName": "Michael Smith",
"postCode": "M1 1AA",
"dateOfBirth": "1985-03-15",
"countryOfBirth": "GB"
}
}
}'
The parameters for adding South African bank account beneficiaries are:
Parameter | Description | Required |
---|---|---|
type | The type of destination. Must be "BANK". | ✅ |
accountName | Name of the beneficiary's account. A space separated first and last name must be provided for individual beneficiaries e.g Marie Dubois | ✅ |
accountNumber | The beneficiary's Account number. | ✅ |
remittancePurpose | Purpose of the remittance. See accepted remittance purposes here (opens in a new tab) | ✅ |
bankCode | Code of the receiving bank | ✅ |
sender | Sender information varies depending on type. Sender type can either be BUSINESS or INDIVIDUAL. | ✅ |
beneficiary | Beneficiary information. | ✅ |
Sender Parameters (Business)
Parameter | Description | Required |
---|---|---|
sender[type] | Type of sender. Must be "BUSINESS". | ✅ |
sender[phoneNumber] | Sender's phoneNumber address | ✅ |
sender[registeredName] | Business registered name | ✅ |
Sender Parameters (Individual)
Parameter | Description | Required |
---|---|---|
sender[type] | Type of sender. Must be "INDIVIDUAL" | ✅ |
sender[phoneNumber] | Sender's phoneNumber address | ✅ |
Beneficiary Parameters
Parameter | Description | Required |
---|---|---|
beneficiary[type] | Type of beneficiary, either "BUSINESS" or "INDIVIDUAL" | ✅ |
beneficiary[accountName] | Name of the beneficiary's account. | ✅ |
beneficiary[postCode] | Beneficiary's postcode. | ✅ |
beneficiary[dateOfBirth] | Beneficiary's date of birth. It is only required when type is 'INDIVIDUAL' | ✅ |
beneficiary[countryOfBirth] | Beneficiary's country of birth. It is only required when type is 'INDIVIDUAL' | ✅ |
beneficiary[country, address] | Beneficiary's address details. It is only required when type is 'BUSINESS' | ✅ |
beneficiary[businessRegistrationNumber] | Beneficiary's business registered number. It is only required when type is 'BUSINESS' | ✅ |