First of all, it receives the filters to be applied in order to return a route and payment information to do the whitelist/blacklist process. It searches into the database by the requested filters and returns every route that matches with them linked with an account and the scheme. If filters don't match with any Route, it returns an empty list. If there is any error, it is also returned.
"currency", "accountFormat" and "accountNumber" have to be received in "routeParams" or in the Pacs.
OAuth Grant type, JWT Profile
Identifies the client of the api
Post body
Route Post Payload Pacs
{
"routeParams": {
"owner": "pagonxt_es",
"accountFormat": "BIC",
"accountNumber": "NWBKGB2LXXX",
"currency": "EUR",
"chargeType": "OUR",
"originBank": "BOFAGB20XXX",
"originCountry": "ES",
"destinationCountry": "US",
"paymentAmount": "100",
"volumePercentage": "10",
"clearingScheme": "GB CHAPS",
"serviceCode": "FPS,SC"
},
"config": {
"sameCorrespondent": true,
"searchIntermediary": true,
"commonCorrespondent": true,
"beneficiaryCorrespondent": "BOFAUS20",
"ssiCorrespondentSteps": "2"
},
"flags": {
"deliveryDate": true
},
"extraDetails": {
"AppHdr": {
"Fr": {
"FIId": {
"FinInstnId": {
"BICFI": "PAGOES22XXX"
}
}
},
"To": {
"FIId": {
"FinInstnId": {
"BICFI": "BOFAUS3NXXX"
}
}
},
"BizMsgIdr": "3621GBQ017447",
"MsgDefIdr": "pacs.008.001.08",
"BizSvc": "swift.cbprplus.02",
"CreDt": "9999-12-31T00:00:00+00:00",
"Rltd": [
{
"Fr": {
"FIId": {
"FinInstnId": {
"BICFI": "WFBIUS6SDAL"
}
}
},
"To": {
"FIId": {
"FinInstnId": {
"BICFI": "TEXSUS41XXX"
}
}
},
"BizMsgIdr": "C2D0506272708",
"MsgDefIdr": "pacs.008.001.08",
"BizSvc": "swift.cbprplus.02",
"CreDt": "2020-01-11T12:50:41.960-05:00"
}
]
},
"Document": {
"FIToFICstmrCdtTrf": {
"GrpHdr": {
"MsgId": "test",
"CreDtTm": "2023-01-01T01:01:01.100Z",
"NbOfTxs": "10",
"SttlmInf": {
"SttlmMtd": "INDA"
}
},
"CdtTrfTxInf": [
{
"Dbtr": {
"Nm": "Joe Exotic"
}
}
]
}
}
}
}Post body
Route params
Legal entity
Account format. The valid values are set in the National ID Format SWIFT file and in the ClrSysMmbId ClrSysId Cd ISO pacs.
Account number to be used in the validations.
Currency ISO code
Payment charge type or expenses type.
BIC list
BIC list
list of countries separated by commas
list of countries separated by commas
Payment amount.
Volume Percentage.
list of clearing schemes separated by commas
service codes separated by commas
Code word
Individual Code word
Customer ID
UUID
Config
Boolean to enable or disable the sameCorrespondent filter
Boolean to enable or disable the searchIntermediary filter
Boolean to enable or disable the commonCorrespondent filter
BIC
Level deep to find the Beneficiary correspondents.
Flags used to activate functionality
It activates delivery date calculation
If true it returns all routes, if false only returns the first one
Any payment object type to be used in the whitelist/blacklist calculation
App Header ISO Pacs 008
Codelist containing the names of the UNICODE code block name as specified on http://unicode.org/Public/UNIDATA/Blocks.txt.
Identification of a person, an organisation or a financial institution.
Specifies the identification of a person or an organisation.
Name by which a party is known and which is usually used to identify that party.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Identification of a person, an organisation or a financial institution.
Specifies the identification of a person or an organisation.
Name by which a party is known and which is usually used to identify that party.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Identifies the implementation specification to which the ISO 20022 message conforms.
Specifies a character string with a maximum length of 350 characters.
Specifies a character string with a maximum length of 2048 characters.
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
Specifies if this document is a copy, a duplicate, or a duplicate of a copy.
Indicates a "Yes" or "No" type of answer for an element.
Specifies the priority levels for the BusinessMessage. The different priorities are typically user / service / implementation dependent. The semantics of the different values for a Mesage (Set) need to be defined by the relevant user community (SEG.).
The W3C XML Schema that specifies following standard signature: XML Signature Syntax and Processing (Second Edition) W3C Recommendation 10 June 2008 http://www.w3.org/TR/2008/REC-xmldsig-core-20080610/.
Rltd App Header ISO Pacs 008 list
Rltd App Header ISO Pacs 008
Codelist containing the names of the UNICODE code block name as specified on http://unicode.org/Public/UNIDATA/Blocks.txt.
Identification of a person, an organisation or a financial institution.
Specifies the identification of a person or an organisation.
Name by which a party is known and which is usually used to identify that party.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Identification of a person, an organisation or a financial institution.
Specifies the identification of a person or an organisation.
Name by which a party is known and which is usually used to identify that party.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Identifies the implementation specification to which the ISO 20022 message conforms.
Specifies a character string with a maximum length of 350 characters.
Specifies a character string with a maximum length of 2048 characters.
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
Specifies if this document is a copy, a duplicate, or a duplicate of a copy.
Indicates a "Yes" or "No" type of answer for an element.
Specifies the priority levels for the BusinessMessage. The different priorities are typically user / service / implementation dependent. The semantics of the different values for a Mesage (Set) need to be defined by the relevant user community (SEG.).
The W3C XML Schema that specifies following standard signature: XML Signature Syntax and Processing (Second Edition) W3C Recommendation 10 June 2008 http://www.w3.org/TR/2008/REC-xmldsig-core-20080610/.
The document to extract the info from.
Scope The PaymentReturn message is sent by an agent to the previous agent in the payment chain to undo a payment previously settled. Usage The PaymentReturn message is exchanged between agents to return funds after settlement of credit transfer instructions (that is FIToFICustomerCreditTransfer message and FinancialInstitutionCreditTransfer message) or direct debit instructions (FIToFICustomerDirectDebit message). The PaymentReturn message should not be used between agents and non-financial institution customers. Non-financial institution customers will be informed about a debit or a credit on their account(s) through a BankToCustomerDebitCreditNotification message ('notification') and/or BankToCustomerAccountReport/BankToCustomerStatement message ('statement'). The PaymentReturn message can be used to return single instructions or multiple instructions from one or different files. The PaymentReturn message can be used in domestic and cross-border scenarios. The PaymentReturn message refers to the original instruction(s) by means of references only or by means of references and a set of elements from the original instruction.
Set of characteristics shared by all individual transactions included in the message.
Specifies a character string with a maximum length of 35 characters.
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
Specifies a numeric string with a maximum length of 15 digits.
Provides further details on the settlement of the instruction.
Specifies the method used to settle the credit transfer instruction.
Scope The FinancialInstitutionToFinancialInstitutionCustomerCreditTransfer message is sent by the debtor agent to the creditor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to move funds from a debtor account to a creditor. Usage The FIToFICustomerCreditTransfer message is exchanged between agents and can contain one or more customer credit transfer instructions. The FIToFICustomerCreditTransfer message does not allow for grouping: a CreditTransferTransactionInformation block must be present for each credit transfer transaction.
Set of elements providing information specific to the individual credit transfer(s)
Set of elements providing information specific to the individual credit transfer(s).
Specifies the identification of a person or an organisation.
Name by which a party is known and which is usually used to identify that party.
FinancialInstitutionCreditTransferV08
Set of characteristics shared by all individual transactions included in the message.
Specifies a character string with a maximum length of 35 characters.
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
Specifies a numeric string with a maximum length of 15 digits.
Provides further details on the settlement of the instruction.
Specifies the method used to settle the credit transfer instruction.
Set of elements providing information specific to the individual credit transfer(s)
Set of elements providing information specific to the individual credit transfer(s).
PartyIdentification7
Specifies a character string with a maximum length of 35 characters.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
PACS004 Document
Scope The PaymentReturn message is sent by an agent to the previous agent in the payment chain to undo a payment previously settled. Usage The PaymentReturn message is exchanged between agents to return funds after settlement of credit transfer instructions (that is FIToFICustomerCreditTransfer message and FinancialInstitutionCreditTransfer message) or direct debit instructions (FIToFICustomerDirectDebit message). The PaymentReturn message should not be used between agents and non-financial institution customers. Non-financial institution customers will be informed about a debit or a credit on their account(s) through a BankToCustomerDebitCreditNotification message ('notification') and/or BankToCustomerAccountReport/BankToCustomerStatement message ('statement'). The PaymentReturn message can be used to return single instructions or multiple instructions from one or different files. The PaymentReturn message can be used in domestic and cross-border scenarios. The PaymentReturn message refers to the original instruction(s) by means of references only or by means of references and a set of elements from the original instruction.
Set of characteristics shared by all individual transactions included in the message.
Specifies a character string with a maximum length of 35 characters.
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
Specifies a numeric string with a maximum length of 15 digits.
Provides further details on the settlement of the instruction.
Specifies the method used to settle the credit transfer instruction.
PACS 008 in JSON format
Scope The FinancialInstitutionToFinancialInstitutionCustomerCreditTransfer message is sent by the debtor agent to the creditor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to move funds from a debtor account to a creditor. Usage The FIToFICustomerCreditTransfer message is exchanged between agents and can contain one or more customer credit transfer instructions. The FIToFICustomerCreditTransfer message does not allow for grouping: a CreditTransferTransactionInformation block must be present for each credit transfer transaction.
Set of elements providing information specific to the individual credit transfer(s)
Set of elements providing information specific to the individual credit transfer(s).
Specifies the identification of a person or an organisation.
Name by which a party is known and which is usually used to identify that party.
PACS009 Document
FinancialInstitutionCreditTransferV08
Set of characteristics shared by all individual transactions included in the message.
Specifies a character string with a maximum length of 35 characters.
A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format
Specifies a numeric string with a maximum length of 15 digits.
Provides further details on the settlement of the instruction.
Specifies the method used to settle the credit transfer instruction.
Set of elements providing information specific to the individual credit transfer(s)
Set of elements providing information specific to the individual credit transfer(s).
PartyIdentification7
Specifies a character string with a maximum length of 35 characters.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Requested filters are OK. It returns a Route array if any Route is found, otherwise, it returns an empty array.
OK: Correspondent Routes Found
{
"data": {
"requestId": "54100696-ea20-4cfb-af45-7a7ea5bba5fd",
"scenario": "correspondent",
"routedAgent": {
"FinInstnId": {
"BICFI": "BSCHESMMXXX"
},
"rma": {
"status": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
},
"source": "IBAN"
},
"requestOrigin": {
"BICFI": "PAGOGB20",
"shortCode": "pagofx_uk"
},
"routingParameters": {
"requestOriginConfiguration": {
"searchIntermediary": true,
"commonCorrespondent": true,
"ssiCorrespondentSteps": "2"
},
"paymentInputs": {
"currency": "EUR",
"chargeType": "BEN",
"originBank": "BSCHKYK0XXX",
"urgency": "URGT"
},
"volumeDistributionSeed": "33"
},
"routes": [
{
"priority": "1",
"appliedParameters": {
"currency": "EUR",
"ssiCorrespondentSteps": "2"
},
"counterparty": {
"name": "santander_es",
"bic": "BSCHESM0XXX",
"cutOff": {
"time": "10:00:00",
"timeZone": "Europe/London"
},
"scheme": {
"schemeId": "EMU TGT2",
"currencies": [
"EUR"
],
"participationType": "direct",
"settlingParticipant": {
"FinInstnId": {
"Nm": "Santander Espana",
"BICFI": "BSCHESM0"
}
}
},
"settlementMethod": "INGA",
"account": {
"type": "IBAN",
"number": "ES9121000418450200051332"
},
"withinCutoff": true,
"ssiRoute": false
},
"schemeInformation": {
"operatingDays": "[1,5]",
"operatingHours": "[09:03:00,12:04:00]",
"isCurrentlyOpen": true,
"needsFX": false,
"overrideSender": "PAGOESMMXXX",
"overrideReceiver": "BSCHESDE"
},
"channels": [
{
"channel": "SWIFT",
"format": "MT103",
"paymentTypes": [
"customer treasury",
"internal treasury"
],
"priority": "1"
}
]
}
]
}
}OK: SSI Correspondent Routes Found with correspondent chain
{
"data": {
"requestId": "54100696-ea20-4cfb-af45-7a7ea5bba5fd",
"scenario": "correspondent",
"routedAgent": {
"FinInstnId": {
"BICFI": "RZBAATWWXXX"
},
"rma": {
"status": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
},
"source": "IBAN"
},
"requestOrigin": {
"BICFI": "PAGOGB20",
"shortCode": "pagofx_uk"
},
"routingParameters": {
"requestOriginConfiguration": {
"ssiCorrespondentSteps": "3"
},
"paymentInputs": {
"currency": "EUR",
"urgency": "URGT"
},
"volumeDistributionSeed": "33"
},
"routes": [
{
"priority": "1",
"appliedParameters": {
"currency": "EUR",
"ssiCorrespondentSteps": "3"
},
"counterparty": {
"name": "bofa_uk",
"bic": "BOFAGB20XXX",
"cutOff": {
"time": "16:30:00",
"timeZone": "Europe/London"
},
"scheme": {
"schemeId": "EMU TGT2",
"currencies": [
"EUR"
],
"participationType": "direct",
"settlingParticipant": {
"FinInstnId": {
"Nm": "Santander Espana",
"BICFI": "BSCHESM0"
}
}
},
"settlementMethod": "INGA",
"account": {
"type": "IBAN",
"number": "ES9121000418450200051332"
},
"withinCutoff": true,
"ssiRoute": true
},
"routedAgentCounterparty": {
"BICFI": "RZBAATWWXXX",
"rma": {
"exchanged": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
}
},
"routedChainAgents": [
{
"BICFI": "RZBAATWWXXX",
"rma": {
"exchanged": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
}
},
{
"BICFI": "NBADAEAAXXX",
"rma": {
"exchanged": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
}
},
{
"BICFI": "CBAUAEAAXXX",
"rma": {
"exchanged": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
}
}
],
"schemeInformation": {
"operatingDays": "[1,5]",
"operatingHours": "[09:03:00,12:04:00]",
"isCurrentlyOpen": true,
"needsFX": false
},
"channels": [
{
"channel": "SWIFT",
"format": "MT103",
"paymentTypes": [
"customer treasury",
"internal treasury"
]
}
]
}
]
}
}OK: No Routes provided
{
"data": {
"requestId": "54100696-ea20-4cfb-af45-7a7ea5bba5fd",
"scenario": "correspondent",
"routedAgent": {
"FinInstnId": {
"BICFI": "RZBAATWWXXX"
},
"rma": {
"status": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
},
"source": "IBAN"
},
"requestOrigin": {
"BICFI": "PAGOGB20",
"shortCode": "pagofx_uk"
},
"routingParameters": {
"requestOriginConfiguration": {
"ssiCorrespondentSteps": "3"
},
"paymentInputs": {
"currency": "GBP",
"urgency": "URGT"
},
"volumeDistributionSeed": "33"
},
"routes": [],
"noRoutesReason": {
"code": "ED01",
"reasonDescription": "No routes provided"
}
}
}OK: All routes blacklisted or not passing every whitelist rule
{
"data": {
"requestId": "54100696-ea20-4cfb-af45-7a7ea5bba5fd",
"scenario": "correspondent",
"routedAgent": {
"FinInstnId": {
"BICFI": "RZBAATWWXXX"
},
"rma": {
"status": true,
"rmaPlus": {
"mtMessages": [
"103",
"202"
],
"mxMessages": [
"pacs.008",
"pacs.009"
]
}
},
"source": "IBAN"
},
"requestOrigin": {
"BICFI": "PAGOGB20",
"shortCode": "pagofx_uk"
},
"routingParameters": {
"requestOriginConfiguration": {
"ssiCorrespondentSteps": "3"
},
"paymentInputs": {
"currency": "GBP",
"urgency": "URGT"
},
"volumeDistributionSeed": "33"
},
"routes": [],
"noRoutesReason": {
"code": "RR04",
"reasonDescription": "All routes blacklisted or not passing every whitelist rule"
}
}
}Array of calculated routes returned
Scenario and routes data
UUID
Payment scenario
Final beneficiary bank (previous beneficiary)
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Status between the correspondent and its messages and services
Indicates the status
RMA information
Array of available MT types
MT type
Array of available MX types
MX type
Where the information has been taken (IBAN / Intermediary / Creditor Agent)
Owner information
Legal entity short code
BIC
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Used inputs to calculate the route
Route configuration
Flag to activate intermediary piston
Flag to activate common correspondent piston
SSI Correspondent Steps
If Beneficiary BIC is same as Correspondent one
BIC
Payment input parameters
Currency ISO code
Payment charge type or expenses type.
BIC list
BIC list
list of countries separated by commas
list of countries separated by commas
Payment amount.
Code word
Individual Code word
Urgency level
Volume Percentage.
Clearing scheme list
Individual clearing scheme
Service code list
Individual service code
Available routes
Payment route
Rule/scheme/channel priority
Route charge code passed on to our correspondent network
Payment charge type or expenses type.
Routing correspondent bank
BIC
Status between the correspondent and its messages and services
Exchange status
RMA information
Array of available MT types
MT type
Array of available MX types
MX type
Beneficiary Correspondent Chain (in deep) when ssi_correspondent_steps is set to > 2 and it obtains results
Agent information
BIC
Status between the correspondent and its messages and services
Exchange status
RMA information
Array of available MT types
MT type
Array of available MX types
MX type
Route counterparty
Legal entity short code
BIC
Cutoff information object
Time with seconds
Timezone
Scheme routing information
Individual clearing scheme
Scheme currencies
Currency ISO code
Scheme participation
Settling participant
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Settlement method selected
Route account information
Account type
Account format (IBAN or BBAN)
If Correspondent is in the cutoff time
If returned route comes from SSI plus table
Date
Used parameters to create the route
Currency ISO code
Payment charge type or expenses type.
BIC
Country ISO code
Country ISO code
Payment amount.
If Beneficiary BIC is same as Correspondent one
Volume Percentage.
Use search intermediary piston
Use common correspondent piston
Clearing scheme list
Individual clearing scheme
Service code list
Individual service code
SSI Correspondent Steps
Scheme config
Bank open days
Bank operating hours
It is open today and inside operating hours
Limits
it needs FX
BIC
BIC
Scheme channel
Individual scheme channel
Individual scheme channel
Format
Payment types
Individual payment type
UUID
Rule/scheme/channel priority
UUID
Payment scenario
Final beneficiary bank (previous beneficiary)
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Status between the correspondent and its messages and services
Indicates the status
RMA information
Array of available MT types
MT type
Array of available MX types
MX type
Where the information has been taken (IBAN / Intermediary / Creditor Agent)
Owner information
Legal entity short code
BIC
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Used inputs to calculate the route
Route configuration
Flag to activate intermediary piston
Flag to activate common correspondent piston
SSI Correspondent Steps
If Beneficiary BIC is same as Correspondent one
BIC
Payment input parameters
Currency ISO code
Payment charge type or expenses type.
BIC list
BIC list
list of countries separated by commas
list of countries separated by commas
Payment amount.
Code word
Individual Code word
Urgency level
Volume Percentage.
Clearing scheme list
Individual clearing scheme
Service code list
Individual service code
Available routes
Payment route
Rule/scheme/channel priority
Route charge code passed on to our correspondent network
Payment charge type or expenses type.
Routing correspondent bank
BIC
Status between the correspondent and its messages and services
Exchange status
RMA information
Array of available MT types
MT type
Array of available MX types
MX type
Beneficiary Correspondent Chain (in deep) when ssi_correspondent_steps is set to > 2 and it obtains results
Agent information
BIC
Status between the correspondent and its messages and services
Exchange status
RMA information
Array of available MT types
MT type
Array of available MX types
MX type
Route counterparty
Legal entity short code
BIC
Cutoff information object
Time with seconds
Timezone
Scheme routing information
Individual clearing scheme
Scheme currencies
Currency ISO code
Scheme participation
Settling participant
Specifies the details to identify a financial institution.
BIC identifier (2014 version)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
Choice of a clearing system identifier.
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Specifies a character string with a maximum length of 140 characters.
Information that locates and identifies a specific address, as defined by postal services.
Choice of formats for the type of address.
Specifies the type of address.
Information related to an identification, for example, party identification or account identification.
Specifies an alphanumeric string with a length of 4 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 70 characters.
Specifies a character string with a maximum length of 16 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Specifies a character string with a maximum length of 35 characters.
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Specifies a character string with a maximum length of 70 characters.
Information related to an identification of a financial institution.
Specifies a character string with a maximum length of 35 characters.
Settlement method selected
Route account information
Account type
Account format (IBAN or BBAN)
If Correspondent is in the cutoff time
If returned route comes from SSI plus table
Date
Used parameters to create the route
Currency ISO code
Payment charge type or expenses type.
BIC
Country ISO code
Country ISO code
Payment amount.
If Beneficiary BIC is same as Correspondent one
Volume Percentage.
Use search intermediary piston
Use common correspondent piston
Clearing scheme list
Individual clearing scheme
Service code list
Individual service code
SSI Correspondent Steps
Scheme config
Bank open days
Bank operating hours
It is open today and inside operating hours
Limits
it needs FX
BIC
BIC
Scheme channel
Individual scheme channel
Individual scheme channel
Format
Payment types
Individual payment type
UUID
Rule/scheme/channel priority
Reason when all the routes have been blacklisted
Code
Reason description
Bad Request
{
"errors": [
{
"code": "400",
"message": "BAD_REQUEST",
"level": "FATAL",
"description": "Bad request"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
User not authorized
{
"errors": [
{
"code": "401",
"message": "UNAUTHORIZED",
"level": "FATAL",
"description": "User unauthorized"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Access forbidden
{
"errors": [
{
"code": "403",
"message": "FORBIDDEN",
"level": "ERROR",
"description": "Access forbidden"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Not Found
Not found
{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "Not found"
}
]
}The Correspondent was not found
{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "Correspondent could not be found"
}
]
}{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "No Route was found"
}
]
}The Requested account data is not found
{
"errors": [
{
"code": "404",
"message": "NOT_FOUND",
"level": "ERROR",
"description": "The requested Account Number is not a valid _accountFormat_ account"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
The Accept header does not specifically contains one of the allowable types, usually 'application/json'
{
"errors": [
{
"code": "406",
"message": "NOT_ACCEPTABLE",
"level": "ERROR",
"description": "Accept header is not application/json"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Tipically for a resorce not found when PUT, PATCH or DELETE or a GET with a resource
{
"errors": [
{
"code": "CONFLICT",
"message": "Conflict",
"level": "ERROR",
"description": "Conflict"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Most web servers have a limit of 8192 bytes (8 KB). The server will close the connection to prevent the client from continuing the request.
{
"errors": [
{
"code": "413",
"message": "REQUEST_ENTITY_TOO_LARGE",
"level": "ERROR",
"description": "Request entity larger than 8192 bytes - 8KB"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
URI request is longer than 2,000 characters
{
"errors": [
{
"code": "414",
"message": "URI_TOO_LONG",
"level": "ERROR",
"description": "URI request is longer than 2000 characters"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
The requested content type is not supported
{
"errors": [
{
"code": "415",
"message": "UNSUPPORTED_MEDIA_TYPE",
"level": "ERROR",
"description": "The requested content type is not supported"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Unprocessable Entity
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "Unprocessable entity"
}
]
}{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "unexpected keys on object - wrong_key"
}
]
}The requested parameters contain an invalid Currency value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - currency - It must be present in routeParams or extraDetails pacs - IntrBkSttlmAmt.Ccy"
}
]
}The requested parameters contain an invalid account format/number value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - accountFormat or accountNumber - They must be present in routeParams or extraDetails pacs - IntrmyAgt1.FinInstnId CdtrAcct.Id.IBAN or CdtrAgt.FinInstnId"
}
]
}The requested parameters contain an invalid Charge Type value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - chargeType - No union satisfied. expected value to be literal OUR but got foobar expected value to be literal BEN but got foobar expected value to be literal SHA but got foobar"
}
]
}The requested parameters contain an invalid Origin Bank value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - originBank - expected string to match pattern but did not"
}
]
}The requested parameters contain an invalid Origin Country value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - originCountry - expected string to match pattern but did not"
}
]
}The requested parameters contain an invalid Payment Amount value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - paymentAmount - expected type to be number but got string"
}
]
}The requested parameters contain an invalid Value Percentage value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - volumePercentage - expected number to be less than or equal to 100 but got 999999"
}
]
}The requested parameters contain an invalid Permanent Input value
Permanent Inputs: sameCorrespondent, volumePercentage, searchIntermediary, commonCorrespondent.
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - sameCorrespondent - No union satisfied. expected string to be one of - true false. expected type to be boolean but got string"
}
]
}The Request parameters contain an invalid Clearing Scheme value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - clearingScheme - expected string to match pattern but did not"
}
]
}The Request parameters contain an invalid Service Code value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - serviceCode - expected string to match pattern but did not"
}
]
}The Request parameters contain an invalid SSI Correspondent Steps value
{
"errors": [
{
"code": "422",
"message": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"description": "error parsing object at path - ssiCorrespondentSteps - expected number to be less than or equal to 10 but got 11"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
The user has sent too many requests in a given amount of time
{
"errors": [
{
"code": "429",
"message": "TOO_MANY_REQUESTS",
"level": "ERROR",
"description": "Too many requests"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Internal Server Error
Internal Server Error
{
"errors": [
{
"code": "500",
"message": "INTERNAL_SERVER_ERROR",
"level": "ERROR",
"description": "Unknown error caught in the error middleware"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Service is unavailable
{
"errors": [
{
"code": "503",
"message": "SERVICE_UNAVAILABLE",
"level": "ERROR",
"description": "Service is unavailable"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Gateway timeout
{
"errors": [
{
"code": "504",
"message": "GATEWAY_TIMEOUT",
"level": "ERROR",
"description": "Gateway timeout"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Internal Server Error
Internal Server Error
{
"errors": [
{
"code": "500",
"message": "INTERNAL_SERVER_ERROR",
"level": "ERROR",
"description": "Unknown error caught in the error middleware"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue