Reason Codes
This page aims to serve as a dictionary of IPF proprietary reason codes that are returned by different IPF components to convey an outcome of IPF business function.
Reason codes are a standard way to return information on outcome of an IPF business function API call, this could be a remote HTTP API call or Java interface. They may often be used to provide information in addition to an error code, but they may also be used in a successful API response
It is important to note that not all IPF business functions use reason codes and as more business functions start using them, they will be added here so the list of reason codes and usage within IPF can be found in one place.
Reason Code Format
IPF reason codes follow below format
IPFXXXnnn
| Characters | Format | Details |
|---|---|---|
1-3 |
"IPF" |
Constant "IPF" representing these are IPF reason codes. |
4-6 |
3 Uppercase alpha characters representing the function |
Representing the business function. These are not a representation of the application/service, but the logical business function. When an application/service supports multiple functions, it would have multiple different business function codes. |
7-9 |
3 digit numeric |
Including leading "0"s. Starting at 001 and incrementing as new codes are added. |
IPF reason codes are also associated with descriptions that describe the nature of outcome of the business function call.
Reason Codes List
Business Function - Reachability
| Reason Code | Reason Description |
|---|---|
IPFRCH001 |
Transfer Currency cannot be settled. |
IPFRCH002 |
IBAN deconstruction failed. |
IPFRCH003 |
Participation details not specified on Agent Settings. |
IPFRCH004 |
Participation identifier look up did not return required identifier type, check party entity directory. |
IPFRCH005 |
Counter Party is not a participant for specified Agent. |
IPFRCH006 |
Transfer Currency different from Settlement Account currency. Limit checks not supported. |
IPFRCH007 |
Multiple settlement accounts exist for Transfer Currency. Limit checks not supported. |
IPFRCH008 |
Transfer amount is greater than allowed limits. |
IPFRCH009 |
AgentUniqueId on selection order not found. |
IPFRCH010 |
Intra Entity Parties list not defined for the Processing Entity. |
IPFRCH011 |
Supported transfer currencies not defined for processing entity. |
IPFRCH012 |
Multiple party entity records match on Party Entity Directory for specified identifier value. Reachability request can be re-run including the identifier type used for membership by the Agent for accurate results. |