CSM Reachability Operations

validate-intra-entity-reachability

Validate if the payment can be settled "Inta Entity" (within the processing entity itself) without using an external CSM Agent.

Validates that the counterparty on the payment is on the Intra Entity Parties list and optionally the currency is on supported transfer currency list with Intra Entity flag as "True".

validate-csm-reachability

Validate if the counterparty is reachable through a specific CSM Agent for given payments data.

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.

processing-entities

Retrieve details of a 'Processing Entity' and optionally associated Generic Processing Settings like Processing Entity Accounts, Supported Transfer Currencies and Intra Entity Parties.

Any client implementation specific Generic Processing settings, if defined, can also be retrieved using this API.

settlement-agents

Retrieve Dynamic configurations associated with a specific Agent with which the Processing Entity holds a settlement relationship.

This includes Agent Settings as well as optionally Agent Settlement and Agent Clearing settings for an agent using AgentUniqueId or an industry identifier that of the agent.

The data returned can be used for getting the settlement account to be used, knowing the limits data for the agent, operating hours of the agents, type and role of the agent (Refer to API specs for more)

party-entities

Allows look up of a party entity (any Financial Institution) to retrieve industry identifiers and address details. The data returned can be used for payment enrichment for parties involved on the payments.

The parties looked up do not have to have settlement relationship with the Processing Entity.

The data look up is specific to an Industry source supported on Party Entity Directory.

iban-deconstruct

The API provides ability to deconstruct an IBAN to know the country of the entity holding the account, IBAN BIC and IBAN National ID.

The source of data for IBAN Deconstruction is IBAN Plus directory provided by SWIFTRef (IBANPlus, IBAN Structure and IBAN Exclusion List).

bic-validation

API allows validation of a BIC against SWIFTRef Bic Dir 2018. The response confirms if the BIC used on the payment is a valid BIC.

determine-processing-entity

The API allows the processing flows and other IPF services to determine the processing entity associated with an industry identifier (e.g. BIC, NCC, LEI or a custom identifier). The identifiers are looked up on the dynamic configurations of "Processing Entity" and "Generic Processing Settings - Intra Entity Parties".