Address Types and Inputs

Gets all the address types AND inputs for a specified Country

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/countries/{countryCode}/address-types-and-inputs

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.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

countryCodestringRequired

The ISO 3166 alpha-2 country code

Example: PH

Responses

200

Address types and inputs for the specified country.

application/json

400

Invalid country code. Reason code BE001 COUNTRY_CODE_INVALID.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

404

Not found. Applicable reason codes: BE002 COUNTRY_NOT_FOUND, BE006 ADDRESS_TYPE_NOT_FOUND.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/countries/{countryCode}/address-types-and-inputs

HTTPcURLJavaScriptPython

GET /v1/countries/{countryCode}/address-types-and-inputs HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "addressTypeId": "PHACCT",
    "countries": [
      "PH"
    ],
    "addressTypeCode": "ACCT",
    "clearingSystemId": "PHPINST",
    "displayOrder": 3,
    "inputs": [
      {
        "addressInputId": "PHINPT1",
        "label": {
          "addressTypeCode": "ACCT",
          "title": {
            "en": "Account number, 10-18 digits"
          }
        },
        "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"
          }
        },
        "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"
          }
        },
        "attributes": {
          "name": "accountOrProxyId",
          "type": "text",
          "pattern": null,
          "placeholder": "[email protected]",
          "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"
          }
        },
        "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"
          }
        },
        "attributes": {
          "name": "accountOrProxyId",
          "type": "text",
          "pattern": "^\\+(?:[0-9] ?){6,14}[0-9]$",
          "placeholder": "[phone]",
          "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"
          }
        },
        "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"
        }
      }
    ]
  }
]