BIS Innovation Hub
Nexus - Short ReportAbout the BIS Innovation Hub
  • Introduction
    • Nexus Overview
    • How to use this site
    • Overview Report
    • Terminology
  • Payment Setup
    • Key Points
    • Scope of Nexus payments
    • Steps 1-2: Country, Currency & Amount
    • Steps 3-6: Exchange Rates
    • Steps 7-9: Addressing, Proxy Resolution & Confirmation of Payee
    • Steps 10-11: Sanctions screening
    • Step 12: Ask the Sender for approval
    • Step 13-16: Set up and send the payment instruction
    • Step 17: Accept the confirmation and notify Sender
  • Addressing & Proxy Resolution
    • Key Points
    • Overview of Payment Addressing in Nexus
      • Addressing via Proxies (Aliases)
      • Addressing via Account Details
    • Address Types & Inputs
      • Address Types
      • Address Inputs
      • Financial Institution Identification
      • List of PSPs
      • Examples
    • Proxy & Account Resolution Process
      • Step 1: Sender inputs proxy or account details
      • Step 2: Proxy Resolution Messaging Sequence
      • Step 3: Account Resolution Messaging Sequence
      • Step 4: Source PSP processes the results
      • Masking of Display Names
    • Role of the Proxy Directory Operator (PDO)
      • Obligations on the Proxy Directory Operator
      • Obligations of PSPs using the Proxy Directory
      • Onboarding a Proxy Directory Operator onto Nexus
  • FX Provision
    • Key Points
    • Role of the FX Provider
    • How Third-Party FX provision works in Nexus
    • Joining Nexus as a third-party FXP
    • Accessing Instant Payment Systems
    • Onboarding PSPs
    • Obligations & Compliance
    • Revenue model for FXPs
    • Rates from Third-Party FX Providers
      • Improving rates for larger transactions
      • Improving rates for specific PSPs
    • Quotes
    • Managing Liquidity
  • Payment Processing
    • Key Points
    • Accounts & Relationships
    • Maximum value of a Nexus payment
    • Payment Flow (Happy Path)
      • Detailed Flow in Source Country (Sending)
      • Detailed Flow in Destination Country (Receiving)
      • Booking flow for Source PSPs
      • Notifying FXPs of completed payments
    • Validations, Duplicates & Fraud
    • Time critical vs non-time critical payments
    • Special Scenarios
    • Payment setup for PSPs who provide their own FX
    • Unsuccessful Payments (Exceptions)
      • Rejects
      • Recall Requests
      • Returns
      • Investigation & Enquiry
      • Disputes
      • Reconciliation reports
    • Fees
    • Role and responsibilities of the Instant Payment System Operator (IPSO)
    • Ensuring settlement certainty
    • Annex: 4-step vs 5-step Processes in Domestic Clearing and Settlement
    • Annex: Sponsoring PSPs and Sponsored Entities
  • Settlement Access Provision
    • Key Points
    • Role of the Settlement Access Provider (SAP)
    • Joining Nexus as an SAP
    • SAP onboarding of FXPs (or foreign PSPs)
    • Costs and Revenue for SAPs
    • Obligations on the SAP
    • Processing payments as an SAP
      • Payment Process for the Source SAP
      • Payment Process for the Destination SAP
      • How the Destination IPS initiates the payment via the Destination SAP
    • Managing Liquidity as an SAP
  • Messaging & Translation
    • Key Points
    • General Usage of ISO 20022
      • Adherence to CPMI Harmonised ISO 20022 Data Requirements
    • Compatibility with Instant Payments Plus (IP+)
    • Message transformation by Nexus
    • Specific Message Elements
    • Purpose Codes
    • Message Guidelines (Excel)
    • MESSAGE acmt.023 Identification Verification Request
    • MESSAGE acmt.024 Identification Verification Report
    • MESSAGE: pacs.008 FI to FI Customer Credit Transfer
      • pacs.008 Differences from CPMI Harmonisation Requirements
    • MESSAGE pacs.002 Payment Status Report
      • pacs.002 Differences from CPMI/CBPR+ Guidelines
    • MESSAGE: pacs.004 Payment Return (Not yet supported)
    • MESSAGE: camt.054 Bank to Customer Debit Credit Notification
    • Translation To/From Domestic Message Formats
    • Translating To/From ISO 20022 Codes
  • APIs
    • Overview
    • Countries
    • Currencies
    • Address Types and Inputs
    • Financial Institutions
    • Fees and Amounts
    • Intermediary Agents (SAPs)
    • Quotes
    • ISO 20022 Messages
  • About
    • Contact the Nexus Team
  • LEGAL
    • Terms and Conditions of Use
    • Privacy Notice
    • Cookies Notice
Powered by GitBook
On this page
Export as PDF
  1. APIs

Address Types and Inputs

PreviousCurrenciesNextFinancial Institutions

Last updated 6 months ago

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: */*
200

Address types for the specified country

[
  {
    "addressTypeId": "IDACCT",
    "countries": [
      "ID"
    ],
    "addressTypeCode": "ACCT",
    "clearingSystemId": "IDRBFAST",
    "displayOrder": 3
  },
  {
    "addressTypeId": "IDEMAL",
    "countries": [
      "ID"
    ],
    "addressTypeCode": "EMAL",
    "proxyDirectoryId": "IDPROXY",
    "displayOrder": 2
  },
  {
    "addressTypeId": "IDMBNO",
    "countries": [
      "ID"
    ],
    "addressTypeCode": "MBNO",
    "proxyDirectoryId": "IDPROXY",
    "displayOrder": 1
  }
]

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

[
  {
    "addressInputId": "IDINPT1",
    "label": {
      "addressTypeCode": "ACCT",
      "title": {
        "en": "Account number, 9-16 digits",
        "de": "Kontonummer, 9-16 Ziffern"
      }
    },
    "attributes": {
      "name": "accountOrProxyId",
      "type": "number",
      "pattern": "^d{9,11}$",
      "placeholder": "123456789",
      "required": true
    },
    "iso20022XPath": {
      "acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Acct/Id/Othr/Id",
      "pacs008": "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CrtrAcct/Id/Othr/Id"
    }
  },
  {
    "addressInputId": "IDINPT2",
    "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}",
      "placeholder": "AAAAIDAAXXX",
      "required": true
    },
    "iso20022XPath": {
      "acmt023": "/Document/IdVrfctnReq/Vrfctn/PtyAndAcctId/Agt/FinInstnId/BICFI",
      "pacs008": "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CdtrAgt/FinInstnId/BICFI"
    }
  },
  {
    "addressInputId": "IDINPT3",
    "attributes": {
      "name": "addressTypeCode",
      "type": "hidden",
      "value": "ACCT",
      "required": true
    },
    "iso20022XPath": {
      "acmt023": null,
      "pacs008": null
    }
  }
]
  • GETGets all the address types AND inputs for a specified Country
  • GETGet address types (only) for a specified country
  • GETGet the detailed input fields for a specified Address Type