Documentation
Beneficiaries
US Beneficiaries

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",
        "country": "US",
        "state": "CA",
        "city": "San Francisco",
        "postCode": "95000",
        "line1": "110 Gorgas Ave, Suite 400"
        "beneficiary": {
            "type": "BUSINESS",
            "accountName": "TechCity Technologies",
             "country": "US",
             "state": "DE",
             "city": "Lewes",
             "postCode": "19000",
             "line1": "1400 Coastal"
        }
    }
}'

ParameterDescriptionRequired
typeSpecify payment type. We only support ACH at the moment.
accountNumberAccount number of the beneficiary
routingNumberThe routing number of the receiving financial institution
account typeCan be a savings or checking account
bankNameThe name of the receiving bank
stateState of the receiving bank
cityCity of the receiving bank
postCodePost code of the receiving bank
line1Line1 of the receiving bank
Beneficiary[type]The type of beneficiary, BUSINESS or INDIVIDUAL
Beneficiary[accountName]The name of the beneficiary
Beneficiary [country, state, city, postCode, line1]The address of the beneficiary similar to that described above