4. /determine-processing-entity
Purpose
Client Implementation flows designed to process payments as well as IPF CSM Services have a need to know which "Processing Entity" they are processing the payment for.
This is required for enriching the processing context on the payments which helps the payments be visible to right operations teams on IPF GUI and on ODS.
It can also help the client implementations to further retrieve and use dynamic and static configurations that are specific to each processing entity.
The endpoint /determine-processing-entity offers the required features to determine the processing entity associated with available industry identifiers.
IMPORTANT:
-
A payment message being processed by a flow of CSM Service can have multiple parties and associated industry identifiers (e.g. InstdAgt, InstgAgt, DbtrAgt, CdtrAgt etc) . It is responsibility of the flow and CSM Service to determine which of the available parties on the message is deemed as processing entity at each stage of processing and pass on associated industry identifier to the endpoint to determine linked processing entity Id and enrich the payment.
-
The decision on identifying a party on the message as processing entity is not in scope of CSM Reachability service. The service scope is limited to determining processing entity Id associated with an industry identifier of a party that has been deemed as processing entity by the requester.
| The endpoint looks up provided industry identifiers on the dynamic configurations of "Processing Entity" and "Intra Entity Parties" to determine the processing entity. In some cases, it may be necessary to derive the direct participant associated with the industry identifier before using industry identifier of the direct participant to determine processing entity. This determination of processing entity by deriving linked direct participant is not supported yet and will be introduced in future versions. |
Usage
The endpoint /determine-processing-entity can be used by the processing flows and CSM Services to determine processing entity using industry identifiers available on the messages.
The processing entity determined using the API can be used to enrich the processing context of the payments, use localized processing entity specific static and dynamic configurations and to view the payments on IPF operational dashboard or client specific GUI through determined processing entity specific access controls.
Dynamic Configurations
The /determine-processing-entity API uses below dynamic configurations for determination of processing entities. The optionality of the dynamic configurations indicate whether the dynamic configurations are mandatory or not.
| Dynamic Configuration | Optionality | Purpose | Reference |
|---|---|---|---|
Processing Entity |
Mandatory |
Processing Entities will need to be registered with industry identifiers. |
|
Generic Processing Settings - Intra Entity Parties |
Optional |
Intra entity parties can be registered with respective industry identifiers. |
|
IBAN Plus Directory |
Optional |
IBANPlus directory is needed if the client implementations want to use IBAN type identifiers for determining processing entity. |
|
IBAN Structure |
Optional |
IBAN Structure directory is needed if the client implementations want to use IBAN type identifiers for determining processing entity. |
|
Exclusion List |
Optional |
IBAN exclusion list directory is needed if the client implementations want to use IBAN type identifiers for determining processing entity. |
|
Party Entity Directory |
Optional |
Party entity directory will be needed if Intra entity parties are registered while input requests for determination of processing entity are made with identifier types not registered on intra entity parties. This allows the service to look up required identifier types on industry data and determine processing entity based on corresponding identifiers retrieved from industry data source. |
Request and Response
/determine-processing-entity follows below request and response structure. This section provides information on the request and response properties, for detailed API specs, please refer CSM Reachability Service API
API Version 2
Request
| Request Property | Description |
|---|---|
entityIdentifier |
The identifier that should be used to derive the processing entity. |
entityIdentifierType |
The type of identifier being provided on the request. Supported identifier types are, BIC, NCC, LEI, IBAN and a client specific custom identifier. Refer Party Identifiers Explained |
entityIdentifierSubType |
The sub-type of the identifier type being used for look up. Refer API specs for the sub-types supported for each identifier type. |
entityCountry |
ISO3166-2 country code of the entity record being queried. entityCountry is required when querying records of type LEI. |
Response
| Response Property | Description |
|---|---|
processingEntities |
A list of processing entity Ids that match provided industry identifiers on the input. In a valid data set up on a client implementation, only one processing entity id should be derived. When multiple processing entity Ids are determined, this points to an invalid data set up that needs to be addressed. |
reasonCode |
An IPF proprietary reason code that indicates a reason for why processing entity determination was not possible. Please refer Reason Code Dictionary for detailed list of reason codes. |
reasonDescription |
Description of the reason code returned. |
| When an IBAN is provided on the request, the IBAN is deconstructed by the service to use derived identifiers to determine processing entity. |