Inquire About Statuses of a Single Payer ID or Assignee ID | Citi Docs Demo

curl -X POST "https://tts.sit.apib2b.citi.com/citiconnect/sit5/receivablesservices/v1/payerids/inquiry?client_id=898918181818181aczta" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "country_code": "HK",
  "payerid_number": "DE43502109007000000017"
}'

{
  "request_id": "180496fb-a181-4e05-b31c-0e9726fed2f4",
  "country_code": "GB",
  "payerid_details": {
    "payerid_number": "DE43502109007000000018",
    "status": "ACTIVE",
    "reason": "Client",
    "account_details": [
      {
        "client_account": "10953312",
        "branch_code": "600",
        "instruction_currencies": [
          "GBP",
          "INR"
        ],
        "client_segment": "PI",
        "usecase_of_payerid": "Sales"
      }
    ]
  },
  "merchant": {
    "address": "XXX, 123",
    "zipcode": "1234573",
    "city": "ABCDEFHG",
    "state": "XXX",
    "country_code": "GB",
    "party_type_details": "S",
    "name_1": "XXX",
    "name_2": "YYY",
    "date": "2022-02-28",
    "tax_identifier": "12345678",
    "website": "http://www.abc.com",
    "assignee_id": "DE0000000000091567US",
    "assignee_id_status": "ACTIVE"
  },
  "beneficiary": [
    {
      "address": "SAN STREET 123",
      "zipcode": "56787534",
      "city": "London",
      "state": "XXX",
      "country_code": "GB",
      "beneficiary_id": "888888",
      "last_name": "YYY",
      "middle_name": "ZZZ",
      "first_name": "AAA",
      "dob": "2022-02-28",
      "tax_identifier": "12345676"
    },
    {
      "address": "DAN STREET 123",
      "zipcode": "8067865",
      "city": "RTYUI",
      "state": "KKKK",
      "country_code": "GB",
      "beneficiary_id": "999999",
      "last_name": "VVVD",
      "middle_name": "EWEWE",
      "first_name": "JHGFDE",
      "dob": "2020-02-28",
      "tax_identifier": "12345476"
    }
  ]
}

Inquiry endpoint to inquire about the statuses of a single payer ID or assignee ID.

Authentication

AuthorizationBearer

All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Query parameters

client_idstringRequired

This is your unique identifier shared during your CitiConnect API onboarding. This is the same client_id used for OAuth token generation.

Request

Describes the status of payer ID or Assignee ID.

country_codestringRequiredformat: "^[A-Z]{2}$"

The ISO country code specifying which country the account is held with. For example, if we receive a request for Denmark, the county code is DE. For France, the country code is FR. The list of allowed country codes are
DE - Denmark
FR - France
GB - Great Britain
IE - Ireland
NL - Netherlands
US - United states of America
CA - Canada
HK - Hong Kong
SG - Singapore
AU - Australia
NZ - New Zealand
LU - Luxembourg

payerid_numberstringOptional1-35 characters

Unique number assigned for payers and beneficiaries to identify incoming payments. Please provide either the payerid_number or the assignee_id.

assignee_idstringOptional1-100 characters

Assignee ID expected from client for upfront sanction screening and activation of Payer ID number. Please provide either payerid_number or assignee_id.

Response headers

request_idstringOptional

Response

request_idstring<=96 characters

Auto-generated unique identification assigned for the incoming request.

country_codestringformat: "^[A-Z]{2}$"

The ISO country code specifying the country where the account is held. For example, if we receive a request for Germany then the county code is DE. For France, it is FR. The list of allowed country codes are:
DE - Germany
FR - France
GB - Great Britain
IE - Ireland
NL - Netherlands
US - United States
CA - Canada
HK - Hong Kong
SG - Singapore
AU - Australia

payerid_detailsobjectOptional

merchantobjectOptional

beneficiarylist of objectsOptional

error_detailslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

405

Method Not Allowed Error

415

Unsupported Media Type Error

500

Internal Server Error