Documentation for a newer release is available. View Latest

2. /select-csm-agent

Select a CSM Agent through which the counterparty is reachable for given payments data. Uses client defined preferences on the CS Agent Selection Settings to return a preferred reachable CSM Agent for the payment.

Purpose

  1. When one or more CSM Agents are applicable for a given Payment Type, Service Level and Transfer Currencies, the client implementations can set the preference of which CSM Agent should be selected through the Processing Data dynamic configuration of CS Agent Selection Settings.

  2. Payment Types and Service levels are client implementation specific values and need to be defined outside CSM Reachability context as these can vary from client to client and even across Processing Entities. The Payment Types and Service Levels are set on CS Agent Selection settings to ensure right CSM Agent is selected for reachability check.

  3. The API of select-csm-agent, checks the reachability of the all the CSM Agents specified on CS Agent Selection settings (matching specified input criteria) and returns "Highest Order Reachable CSM". This is the first CSM Agent on CS Agent Selection settings through which counterparty is found to be reachable.

  4. The API can also return enhanced CSM Data (like Agent Settings, Agent Clearing and Settlement Settings and the CSM Participant record) so the data can be used for payment enrichment purposes by the payment processing flows.

  5. Alongside "HighestOrderReachableCSM", when requested, the API can also return reachability results across all the CSM Agents specified on CS Agent Selection settings for matching input criteria (irrespective of whether the counterparty is reachable through the CSM Agent or not). This information can come handy when no CSM Agent is found to be reachable so manual intervention can be performed using the reachability result returned for all the matching CSM Agents on CS Agent Selection Settings.

  6. SelectCSM Agent uses Validate CSM Reachability service behavior for checking reachability of Agent listed on Cs Agent Selection settings. For more details,please refer to Validate CSM Reachability

Usage

select csm agent usage.drawio

Request and Response

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

Dynamic Configurations

The API needs below dynamic configurations to be set up:

  1. Processing Data:

    1. Processing Entity (Mandatory)

    2. CS Agent Selection Settings (Mandatory)

    3. Agent Settings (Mandatory)

    4. Agent Settlement Settings (Mandatory)

    5. Agent Clearing Settings (Optional - Needed if Clearing Settings are required in the response following selection of a CSM Agent for payment processing)

  2. Industry Data:

    1. CSM Participant (Optional - Needed if Agents involved have participants)

    2. Party Entity Directory (Optional - Needed if reachability checks are required using identifiers other than those used on Intra Entity Parties list)

    3. IBAN Plus Directory (Optional - Needed if IBAN use is required on Payment flows)

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. IPFRCH009