Gets all the address types AND inputs for a specified Country
get
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.
Path parameters
countryCodestringRequired
The ISO 3166 alpha-2 country code
Example: PH
Responses
200
Address types and inputs for the specified country.
application/json
get
GET /countries/{countryCode}/address-types-and-inputs HTTP/1.1
Host: localhost:3000
Accept: */*
200
Address types and inputs for the specified country.
[
{
"addressTypeId": "PHACCT",
"countries": [
"PH"
],
"addressTypeCode": "ACCT",
"clearingSystemId": "PHPINST",
"displayOrder": 3,
"inputs": [
{
"addressInputId": "PHINPT1",
"label": {
"addressTypeCode": "ACCT",
"title": {
"en": "Account number, 10-18 digits",
"de": "Kontonummer, 10-18 Ziffern"
}
},
"attributes": {
"name": "accountOrProxyId",
"type": "number",
"pattern": "^d{10,18}$",
"placeholder": "1234567890",
"required": true
},
"iso20022XPath": {
"acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Acct/Id/Othr/Id",
"pacs008": "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CrtrAcct/Id/Othr/Id"
}
},
{
"addressInputId": "PHINPT2",
"label": {
"addressTypeCode": "BICFI",
"title": {
"en": "BIC of the Recipient's Bank or Payment Service Provider",
"de": "BIC der Bank oder des Zahlungsdienstleisters des Empfängers"
}
},
"attributes": {
"name": "finInstId",
"type": "text",
"pattern": "^[A-Z]{6}[0-9A-Z]{2}([0-9A-Z]{3})?",
"placeholder": "AAAAPHAAXXX",
"required": true
},
"iso20022XPath": {
"acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Agt/FinInstnId/BICFI",
"pacs008": "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CdtrAgt/FinInstnId/BICFI"
}
}
]
},
{
"addressTypeId": "PHEMAL",
"countries": [
"PH"
],
"addressTypeCode": "EMAL",
"proxyDirectoryId": "PHPROXY",
"displayOrder": 2,
"inputs": [
{
"addressInputId": "PHINPT3",
"label": {
"addressTypeCode": "EMAL",
"title": {
"en": "Email address",
"de": "E-Mail-Addresse"
}
},
"attributes": {
"name": "accountOrProxyId",
"type": "email",
"pattern": null,
"placeholder": "someone@somewhere.com",
"required": true
},
"iso20022XPath": {
"acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Acct/Prxy/Id",
"pacs008": null
}
},
{
"addressInputId": "PHINPT2",
"label": {
"addressTypeCode": "BICFI",
"title": {
"en": "BIC of the Recipient's Bank or Payment Service Provider",
"de": "BIC der Bank oder des Zahlungsdienstleisters des Empfängers"
}
},
"attributes": {
"name": "finInstId",
"type": "text",
"pattern": "^[A-Z]{6}[0-9A-Z]{2}([0-9A-Z]{3})?",
"placeholder": "AAAAPHAAXXX",
"required": true
},
"iso20022XPath": {
"acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Agt/FinInstnId/BICFI",
"pacs008": "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CdtrAgt/FinInstnId/BICFI"
}
}
]
},
{
"addressTypeId": "PHMBNO",
"countries": [
"PH"
],
"addressTypeCode": "MBNO",
"proxyDirectoryId": "PHPROXY",
"displayOrder": 1,
"inputs": [
{
"addressInputId": "PHINPT4",
"label": {
"addressTypeCode": "MBNO",
"title": {
"en": "Mobile phone number, including the country code",
"de": "Mobiltelefonnummer, einschließlich der Landesvorwahl"
}
},
"attributes": {
"name": "accountOrProxyId",
"type": "tel",
"pattern": "^\\+(?:[0-9] ?){6,14}[0-9]$",
"placeholder": "+633456789101",
"required": true
},
"iso20022XPath": {
"acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Acct/Prxy/Id",
"pacs008": null
}
},
{
"addressInputId": "PHINPT5",
"label": {
"addressTypeCode": "BICFI",
"title": {
"en": "BIC of the Recipient's Bank or Payment Service Provider",
"de": "BIC der Bank oder des Zahlungsdienstleisters des Empfängers"
}
},
"attributes": {
"name": "finInstId",
"type": "text",
"pattern": "^[A-Z]{6}[0-9A-Z]{2}([0-9A-Z]{3})?",
"placeholder": "AAAAPHAAXXX",
"required": true
},
"iso20022XPath": {
"acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Agt/FinInstnId/BICFI",
"pacs008": "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CdtrAgt/FinInstnId/BICFI"
}
}
]
}
]
Get address types (only) for a specified country
get
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.
Path parameters
countryCodestringRequired
The ISO 3166 alpha-2 country code
Example: ID
Responses
200
Address types for the specified country
application/json
get
GET /countries/{countryCode}/address-types HTTP/1.1
Host: localhost:3000
Accept: */*
Get the detailed input fields for a specified Address Type
get
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.
Path parameters
addressTypeIdstringRequired
The ID of the address type
Example: IDACCT
Responses
200
Address type inputs for the specified address type
application/json
get
GET /address-types/{addressTypeId}/inputs HTTP/1.1
Host: localhost:3000
Accept: */*
200
Address type inputs for the specified address type
