Documentation
Beneficiaries
US Beneficiaries

US Beneficiary

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

📘 Payout services are currently unavailable for beneficiaries with addresses located in New York or Hawaii due to regulatory restrictions. Please create a beneficiary with address in other US states

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": "Chase Bank",
            "bankAddress": "123 Financial Street",
            "postCode": "94105",
            "city": "San Francisco",
            "state": "California",
            "country": "US",
            "remittancePurpose": "MAINTENANCE_EXPENSES",
            "bankCode": null,
            "beneficiary": {
                "type": "BUSINESS",
                "accountName": "Saul Atta",
                "country": "US",
                "state": "Texas",
                "city": "Austin",
                "address": "123 Tech Avenue",
                "postCode": "78701"
            },
            "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:

ParameterDescriptionRequired
typeSpecify payment type either ACH or WIRE.
We only support ACH for individuals.
accountNumberAccount number of the beneficiary
routingNumberThe routing number of the receiving financial institution
accountTypeCan be a savings or checking account
bankNameThe name of the receiving bank
bankAddressAddress of the receiving bank.
stateState of the receiving bank
cityCity of the receiving bank
postCodePost code of the receiving bank
remittancePurposePurpose of the remittance, selected from predefined options.
See accepted remittance purposes here (opens in a new tab)
senderSender information. Expanded based on sender[type].
beneficiaryBeneficiary information. Expanded based on beneficiary[type].

Sender Parameters

ParameterDescriptionRequired
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

ParameterDescriptionRequired
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.