Address Types and Inputs

Gets all the address types AND inputs for a specified Country

Returns all address types AND their associated inputs for a specified country. This can be used instead of calling the two APIs listed below in sequence.

GEThttp://localhost:3000/countries/{countryCode}/address-types-and-inputs

Path parameters

countryCode*string

The ISO 3166 alpha-2 country code

Example: "PH"

Response

200

Address types and inputs for the specified country.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/countries/{countryCode}/address-types-and-inputs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get address types (only) for a specified country

Returns high-level address types (only) for a specified country, without detail of address inputs. Can be used to generate the form where the Sender selects between (eg) mobile, email address, IBAN etc.

GEThttp://localhost:3000/countries/{countryCode}/address-types

Path parameters

countryCode*string

The ISO 3166 alpha-2 country code

Example: "ID"

Response

200

Address types for the specified country

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/countries/{countryCode}/address-types', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get the detailed input fields for a specified Address Type

Returns the detailed input fields for a specified Address Type, as defined by addressTypeId. Can be used to generate the form where the Sender will provide the account or proxy details for the Recipient.

GEThttp://localhost:3000/address-types/{addressTypeId}/inputs

Path parameters

addressTypeId*string

The ID of the address type

Example: "IDACCT"

Response

200

Address type inputs for the specified address type

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/address-types/{addressTypeId}/inputs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();