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 --globoff '{{sandboxURL}}/beneficiaries' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer {{APIKEY}}' \
    --data-raw '{
        "reference": "<samplereference>",
        "callbackUrl": "https://webhook.site/38a9e65e-3388-4399-89d4-3ceafa817111",
        "country": "US",
        "currency": "USD",
        "customerEmail": "roy@email.com",
        "destination": {
            "type": "ACH",
            "accountNumber": "460940000007191",
            "routingNumber": "1400045300",
            "accountType": "CHECKING",
            "bankName": "Brex",
            "bankAddress": "110 Gorgas Ave, Suite 400",
            "country": "US",
            "state": "CA",
            "city": "San Francisco",
            "postCode": "95000",
            "remittancePurpose": "SALARY_PAYMENT",
            "beneficiary": {
                "type": "BUSINESS",
                "accountName": "TechCity Technologies",
                "country": "US",
                "state": "DE",
                "city": "Lewes",
                "postCode": "19000",
                "address": "1400 Coastal"
            }
        },
        "sender": {
            "type": "BUSINESS",
            "accountName": "Sender Business Name",
            "country": "US",
            "state": "CA",
            "city": "San Francisco",
            "address": "123 Business St",
            "postCode": "94101",
            "businessRegistrationNumber": "123456789"
        }
    }'

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