1. /validate-csm-reachability

Validates the reachability for a counterparty against a specific CSM Agent.

Purpose

  1. In some cases, the client implementation flows or channel applications may have a preferred CSM Agent pre-defined (due to customer preference or organizational policies). In these cases, the reachability check for given counterparty may be needed against a specific CSM Agent rather than selecting a CSM Agent from pre-defined list on CS Agent Selection settings dynamic configuration.

  2. Validate CSM Reachability API allows this reachability check to be done for the counterparty against a specific CSM Agent for given transfer currency and optionally transfer amount.

  3. The reachability check is done against the below criteria:

    1. Settlement - Can the provided transfer currency be settled with the specified CSM Agent?

    2. Participation - Are the counterparty and the CSM Agent the same entity or is the counterparty a participant to the CSM Agent? Key points to note regarding participation criteria checks are:

      1. The participation criteria checks a CSM Participant has an active record, the counterparty identifier has an activeFromDate value less than or equal to the date for which reachability is being checked and the activeToDate is greater than or equal to the same date, if the activeToDate is set.

      2. The participation criteria takes the rMessageOnly flag on the CSM participant record into consideration;

        1. if the request contains rMessage = 'FALSE' (or NULL), participant records with rMessageOnly = 'FALSE' (or NULL) are reachable.

        2. if the request contains rMessage = 'TRUE', participant records with rMessageOnly = 'TRUE'/'FALSE' (or NULL) are reachable.

An rMessageOnly value of 'TRUE' means a participant is reachable for R-messages only, an rMessageOnly value of 'FALSE' means a participant is reachable for new payments or R-messages. Setting the rMessage flag to 'TRUE' in the input request indicates the identifier undergoing reachability checks is from an R-message transaction. An input request without or with the rMessage flag set to 'FALSE' indicates the identifier undergoing reachability checks is from a new transaction.

  1. Limits - Is the transfer amount within the specified limits? Key points to note regarding limit checks are:

    1. The limits criteria is applied only when the request specifies the transfer amount and limits with "limitDirection" of "OUTBOUND" apply when they are configured and applicable.

    2. The limits can be specified at different levels and all applicable limits are checked when limit criteria is applicable. Any limits if specified on dynamic configurations cannot be bypassed by the API; if the client implementations want the limits not to be applied, the limits will need to be removed or reachability checks performed without transfer amounts.

    3. Please refer Determining Applied Limits for more details on how the applied limits are determined during Reachability checks.

Usage

validate csm reachability usage.drawio

Request and Response

Please refer CSM Reachability Service API for the API specifications and example request and responses.

Reason Codes

Possible reason codes are. Please refer Reachability Reason Codes for details on reason codes and descriptions.

  1. IPFRCH001

  2. IPFRCH002

  3. IPFRCH003

  4. IPFRCH004

  5. IPFRCH005

  6. IPFRCH006

  7. IPFRCH007

  8. IPFRCH008

  9. IPFRCH012

  10. IPFRCH013