6. /settlement-agents
Purpose
CSM Reachability service uses multiple data structures that are supported by "Dynamic Processing Settings". The data structures use DPS setting management APIs which allow the records to be created / updated / deleted dynamically. The client implementation payment flows can use the setting management APIs, however this exposes the flows to the risk of the data structure definitions changing as the attributes returned can change as a result.
It is therefore proposed that a 'Domain API’s are available for client implementations to retrieve related dynamic configurations. The candidates for the 'domain APIs' are Agent related settings and processing entity related settings.
The domain API /settlement-agents can be used by client implementations to retrieve details of the agent and associated clearing and settlement settings.
Usage
The domain API of /settlement-agents can be used by the client implementation payment flows to retrieve below aspects of the dynamic configurations related to an agent. (An agent is a party with which the processing entity holds a settlement relationship).
-
Agent Settings
-
Agent Settlement Settings
-
Agent Clearing Settings
Input Request
| Level | Input Attribute | Optionality | Description |
|---|---|---|---|
1 |
ProcessingEntity |
M |
The Processing Entity for which the agent information is required. |
1 |
AgentIdentifier |
M |
An identifier that identifies the agent of the processing entity. |
1 |
AgentIdentifierType |
M |
The type of the identifier that is specified in the request in "AgentIdentifier" field. Below identifier types are supported. Agent identifiers supported are BIC, NCC, LEI and AgentUniqueId |
1 |
AgentIdentifierSubType |
C |
The sub-type of the identifier provided. BIC : accountIssuingBIC, schemeMembershipBIC NCC: Subtype enums are aligned to ISO20022 specified codes. |
1 |
AgentCountry |
C |
2 Char Country Code of the agent. Conditionally mandatory when the IdentifierType is LEI. |
1 |
IncludeSettlementSettings |
O |
Default is considered to be 'False' if not specified. When set to True, Agent Settlement Settings record will be returned for specified agent and transfer currency, if configured. |
2 |
+TransferCurrency |
C |
3 Char Currency code of the transfer currency of the payment. Conditionally mandatory when 'IncludeSettlementSettings' is set to TRUE |
2 |
+TransferDirection |
C |
Conditionally mandatory when 'IncludeSettlementSettings' is set to TRUE. The direction of settlement from processing entity’s point of view should be specified. |
1 |
IncludeClearingSettings |
O |
Default is considered to be 'False'. When set to True, Agent Clearing Settings record will be returned for specified agent, if configured. |
Response
| Level | Attribute | Optionality | Description |
|---|---|---|---|
1 |
Agent Settings |
M |
The record from Agent Settings dynamic configuration returned if the Agent is found with matching AgentIdentifier on the input. |
1 |
Agent Settlement Settings |
O |
The record from Agent Settlement Settings dynamic configuration returned if requested and if the record is found with matching transfer currency on the input. |
1 |
Agent Clearing |
O |
The record from Agent Clearing Settings dynamic configuration returned if requested and if the record is found with matching AgentIdentifier on the input |
- IMPORTANT
-
-
The settlement settings with transfer direction matching the input transfer direction or with the transfer direction of "Bidirectional" are returned, if they are configured.
-
Agent Settlement settings can have below limit categories configured:
-
Agent Limits
-
Custom Participant Limits
-
Participant Country Limits
-
-
The limits can have transfer direction of "Inbound" or "Outbound"
-
The limit values on the Agent Settlement Settings are returned with matching transfer direction on the input, if configured. (Inbound limits returned when input transfer direction is "Inbound" and Outbound limits returned, when input transfer direction is "Outbound")
-
Refer detailed API specifications here Integration.