US Beneficiary

Before making a payment to a US bank account, you are to add a beneficiary.

Sample request for adding a US 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",
        "customerEmail": "roy@example.com",
        "country": "US",
        "currency": "USD",
        "destination": {
            "type": "WIRE",
            "accountType": "CHECKING",
            "accountNumber": "223233432",
            "routingNumber": "232343333",
            "bankName": "Post Bank",
            "bankAddress": "arf",
            "postCode": "293043",
            "city": "Ase",
            "state": "Alaska",
            "country": "US",
            "remittancePurpose": "MAINTENANCE_EXPENSES",
            "bankCode": null,
            "beneficiary": {
                "type": "BUSINESS",
                "accountName": "Saul Atta",
                "country": "Algeria",
                "state": "Ain Temouchent",
                "city": "sde",
                "address": "wer mok",
                "postCode": "234343"
            },
            "sender": {
                "type": "BUSINESS",
                "accountName": "Zenith Global Enterprises Limited",
                "firstName": "Oluwaseun",
                "lastName": "Adebayo",
                "countryOfBirth": "Nigeria",
                "dateOfBirth": "1988-05-21",
                "idType": "PASSPORT",
                "idNumber": "12345678901",
                "country": "Nigeria",
                "state": "Lagos",
                "city": "Ikeja",
                "address": "15 Adebola Street, Computer Village",
                "postCode": "100001",
                "businessRegistrationNumber": "RC-123456"
            }
        }
    }'

The parameters for adding beneficiary for US bank accounts are:

Parameter	Description	Required
type	Specify payment type. We only support ACH at the moment.	✅
accountNumber	Account number of the beneficiary	✅
routingNumber	The routing number of the receiving financial institution	✅
account type	Can be a savings or checking account	✅
bankName	The name of the receiving bank	✅
bankAddress	Address of the receiving bank.	✅
state	State of the receiving bank	✅
city	City of the receiving bank	✅
postCode	Post code of the receiving bank	✅
remittancePurpose	Purpose of the remittance, selected from predefined options. `See accepted remittance purposes` `here` (opens in a new tab)	✅
sender	Sender information. Expanded based on sender[type].	✅
beneficiary	Beneficiary information. Expanded based on beneficiary[type].	✅

Sender Parameters

Parameter	Description	Required
sender[type]	Type of sender, either "BUSINESS" or "INDIVIDUAL".	✅
sender[accountName]	Name of the sender's account.	✅
sender[country, state, city, address, postCode]	Sender's address details: country, state, city, address, and postcode.	✅
sender[businessRegistrationNumber]	Business registration number. `Required if sender is BUSINESS`
sender[dateOfBirth, countryOfBirth]	Sender's date and country of birth. `Required if sender is INDIVIDUAL`
sender[idType, idNumber, idCountry]	Sender's identification details (type, number, and country). `Required if sender is INDIVIDUAL`

Beneficiary Parameters

Parameter	Description	Required
beneficiary[type]	Type of beneficiary, either "BUSINESS" or "INDIVIDUAL".	✅
beneficiary[accountName]	Name of the beneficiary's account.	✅
beneficiary[country, state, city, address, postCode]	Beneficiary's address details: country, state, city, address, and postcode.	✅

Virtual Accounts Australia Beneficiary