Skip to main content

Create International External Account

Suggest Edits

3.1 Overview​

You can create one or multiple international external accounts for a customer or program manager using the POST method, as described below.

3.2 Resource Access​

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/us2/v1/customer/id/{customerId}/internationalExternalAccount

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/us2/v1/customer/id/{customerId}/internationalExternalAccount

3.3 Arguments​

AttributeMandatory / Optional
externalIdOptional
holderNameMandatory
holderAddress.addressLine1Mandatory
holderAddress.addressLine2Optional
holderAddress.cityMandatory
holderAddress.stateOptional
holderAddress.countryMandatory
holderAddress.zipOptional
accountNumberMandatory
swiftCodeMandatory
internationalRoutingCodeOptional
acceptedCurrencyMandatory
typeMandatory
holderTypeMandatory
holderEmailMandatory for non-USD accounts
holderPhoneConditional¹
additionalDetail.<key>Conditional²
purposeConditional³
metaDataOptional
tagsOptional
commentOptional
¹ Country-specific requirement—see “Meta Data API” (§ 4.6.6).
² Required for non-USD accounts; keys vary by jurisdiction (Meta Data API).
³ Mandatory only for certain country-currency corridors.

3.4 Example Requests​

3.4.1 With USD Currency​

POST /banking/us2/v1/customer/id/4000054/internationalExternalAccount HTTP/1.1
Host: {hostname}
Authorization: Bearer {jwtToken}
x-api-key: {apiKey}
Content-Type: application/json
{
    "type": "CHECKING",
    "acceptedCurrency": ["USD"],
    "holderAddress": {
        "state": "AZ",
        "country": "US",
        "addressLine1": "#1233, hazel street",
        "addressLine2": "Temple",
        "city": "Arizona",
        "zip": "85002"
    },
    "holderPhone": "894598345",
    "holderEmail": "abcd@gmail.com",
    "holderName": "Testing",
    "swiftCode": "ADCBAEAA060",
    "accountNumber": "458040789684689",
    "purpose": "Testing",
    "holderType": "CORPORATE"
}

3.4.2 With Non-USD Currency​

POST /banking/us2/v1/customer/id/4000054/internationalExternalAccount HTTP/1.1
Host: {hostname}
Authorization: Bearer {jwtToken}
x-api-key: {apiKey}
Content-Type: application/json
{
    "externalId": "ET234234523567",
    "type": "CHECKING",
    "acceptedCurrency": ["CNY"],
    "holderAddress": {
        "state": "AL",
        "country": "CN",
        "addressLine1": "#1233, hazel street",
        "addressLine2": "Temple",
        "city": "Albert",
        "zip": "T9X"
    },
    "holderPhone": "892298345",
    "holderEmail": "abcd3245@gmail.com",
    "holderName": "Testing",
    "swiftCode": "BKCHCNBJXXX",
    "internationalRoutingCode": "92345",
    "accountNumber": "458940969634567",
    "purpose": "Testing1",
    "additionalDetail": {
        "taxID": "2835"
    },
    "holderType": "CORPORATE"
}

3.5 Example Response​

```http
HTTP/1.1 201 Created
Content-Type: application/json
url: /banking/us2/v1/customer/4000054/internationalExternalAccount/id/4000028

API Documentation​

```

***