7.16 PUT /transfers/{ID}/error

Financial Institution to Financial Institution Payment Status Report - pacs.002.001.15

Context

(DFSP -> DFSP, DFSP -> HUB, HUB -> DFSP)

This is triggered as a callback response to the POST /transfers call when an error occurs. The message is generated by the entity who first encounter the error which can either be the DFSP, or the HUB. All other participants involved are informed by this message. The TxInfAndSts.StsRsnInf.Rsn.Cd contains the Mojaloop error code, which specified the source and cause of the error.

Here is an example of the message:

{
"GrpHdr": {
    "MsgId":"01JBVM1CGC5A18XQVYYRF68FD1",
    "CreDtTm":"2024-11-04T12:57:45.228Z"},
"TxInfAndSts":{"StsRsnInf":{"Rsn": {"Prtry":"ErrorCode"}}}
}

Message Details

The details on how to compose and make this API are covered in the following sections:

1. Core Data Elements This section specifies which fields are required, which fields are optional, and which fields are unsupported in order to meet the message validating requirements.

2. Header Details This general section specifies the header requirements for the API are specified.

3. Supported HTTP Responses This general section specifies the http responses that must be supported.

4. Common Error Payload This general section specifies the common error payload that is provided in synchronous http error response.

Core Data Elements

Here are the core data elements that are needed to meet this market practice requirement.

The background colours indicate the classification of the data element.

Data Model Type Key	Description
required	These fields are required in order to meet the message validating requirements.
optional	These fields can be optionally included in the message. (Some of these fields may be required for a specific scheme as defined in the Scheme Rules for that scheme.)
unsupported	These fields are actively not supported. The functionality specifying data in these fields are not compatible with a Mojaloop scheme, and will fail message validation if provided.

Here is the defined core data element table.

ISO 20022 Field	Data Model	Description
GrpHdr - GroupHeader120	[1..1]	Set of characteristics shared by all individual transactions included in the message.
MsgId - MessageIdentification	[1..1]	Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.
CreDtTm - CreationDateTime	[1..1]	Date and time at which the message was created.
InstgAgt - BranchAndFinancialInstitutionIdentification8	[0..0]	Unique and unambiguous identification of a financial institution or a branch of a financial institution.
InstdAgt - BranchAndFinancialInstitutionIdentification8	[0..0]	Unique and unambiguous identification of a financial institution or a branch of a financial institution.
OrgnlBizQry - OriginalBusinessQuery1	[0..0]
OrgnlGrpInfAndSts - OriginalGroupHeader22	[0..0]
TxInfAndSts - PaymentTransaction161	[1..1]	Information concerning the original transactions, to which the status report message refers.
StsId - Max35Text	[0..1]	Unique identification, as assigned by the original sending party, to unambiguously identify the status report.
OrgnlGrpInf - OriginalGroupInformation29	[0..0]
OrgnlInstrId - Max35Text	[0..1]	Unique identification, as assigned by the original sending party, to unambiguously identify the original instruction. (FSPIOP equivalent: transactionRequestId)
OrgnlEndToEndId - Max35Text	[0..1]	Unique identification, as assigned by the original sending party, to unambiguously identify the original end-to-end transaction. (FSPIOP equivalent: transactionId)
OrgnlTxId - Max35Text	[0..1]	Unique identification, as assigned by the original sending party, to unambiguously identify the original transaction. (FSPIOP equivalent: quoteId)
OrgnlUETR - UUIDv4Identifier	[0..1]	Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.
TxSts - ExternalPaymentTransactionStatus1Code	[0..1]	Specifies the status of the transaction.
StsRsnInf - StatusReasonInformation14	[1..1]	Information concerning the reason for the status.
Orgtr - Originator	[0..1]	Party that issues the status.
Nm - Name	[0..1]	Name by which a party is known and which is usually used to identify that party.
PstlAdr - Postal Address	[0..1]	Information that locates and identifies a specific address, as defined by postal services.
AdrTp - AddressType3Choice	[0..1]	Type of address, as defined by the postal services.
Cd - Code	[0..1]	Type of address expressed as a code.
Prtry - Proprietary	[0..1]	Type of address expressed as a proprietary code.
Id - Identification	[0..1]	Proprietary information, often a code, issued by the data source scheme issuer.
Issr - Issuer	[0..1]	Entity that assigns the identification.
SchmeNm - SchemeName	[0..1]	Short textual description of the scheme.
CareOf - Max140Text	[0..1]	Name of the person or entity the mail is directed to, if different from the recipient.
Dept - Max70Text	[0..1]	Name of a department within an organization.
SubDept - Max70Text	[0..1]	Name of a sub-department within a department.
StrtNm - Max140Text	[0..1]	Name of the street or thoroughfare.
BldgNb - Max16Text	[0..1]	Number that identifies a building on the street.
BldgNm - Max140Text	[0..1]	Name of the building, if applicable.
Flr - Max70Text	[0..1]	Floor number or identifier within a building.
UnitNb - Max16Text	[0..1]	Unit or apartment number within a building.
PstBx - Max16Text	[0..1]	Post office box number.
Room - Max70Text	[0..1]	Room number or identifier within a building.
PstCd - Max16Text	[0..1]	Postal code or ZIP code.
TwnNm - Max140Text	[0..1]	Name of the town or city.
TwnLctnNm - Max140Text	[0..1]	Name of the location within a town or city.
DstrctNm - Max140Text	[0..1]	Name of the district or region.
CtrySubDvsn - Max35Text	[0..1]	Name of the country subdivision, such as a state or province.
Ctry - CountryCode	[0..1]	Country code, as defined by ISO 3166-1 alpha-2.
AdrLine - Max70Text	[0..1]	Free-form text line for the address.
Id - Identification	[0..1]	Unique and unambiguous identification of a party.
OrgId - Organisation	[0..1]	Unique and unambiguous way to identify an organisation.
AnyBIC - AnyBIC	[0..1]	Business identification code of the organisation.
LEI - LEI	[0..1]	Legal entity identification as an alternate identification for a party.
Othr - Other	[0..1]	Unique identification of an organisation, as assigned by an institution, using an identification scheme.
Id - Identification	[0..1]	Identification assigned by an institution.
SchmeNm - SchemeName	[0..1]	Name of the identification scheme.
Cd - Code	[0..1]	Name of the identification scheme, in a coded form as published in an external list.
Prtry - Proprietary	[0..1]	Name of the identification scheme, in a free text form.
Issr - Issuer	[0..1]	Entity that assigns the identification.
PrvtId - Person	[0..1]	Unique and unambiguous identification of a person, for example a passport.
DtAndPlcOfBirth - DateAndPlaceOfBirth	[0..1]	Date and place of birth of a person.
BirthDt - BirthDate	[0..1]	Date on which a person was born.
PrvcOfBirth - ProvinceOfBirth	[0..1]	Province where a person was born.
CityOfBirth - CityOfBirth	[0..1]	City where a person was born.
CtryOfBirth - CountryOfBirth	[0..1]	Country where a person was born.
Othr - Other	[0..1]	Unique identification of a person, as assigned by an institution, using an identification scheme.
Id - Identification	[0..1]	Unique and unambiguous identification of a person.
SchmeNm - SchemeName	[0..1]	Name of the identification scheme.
Cd - Code	[0..1]	Name of the identification scheme, in a coded form as published in an external list.
Prtry - Proprietary	[0..1]	Name of the identification scheme, in a free text form.
Issr - Issuer	[0..1]	Entity that assigns the identification.
CtryOfRes - CountryCode	[0..1]	Country of Residence Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
CtctDtls - Contact Details	[0..1]	Set of elements used to indicate how to contact the party.
NmPrfx - NamePrefix	[0..1]	Specifies the terms used to formally address a person.
Nm - Name	[0..1]	Name by which a party is known and which is usually used to identify that party.
PhneNb - PhoneNumber	[0..1]	Collection of information that identifies a phone number, as defined by telecom services.
MobNb - MobilePhoneNumber	[0..1]	Collection of information that identifies a mobile phone number, as defined by telecom services.
FaxNb - FaxNumber	[0..1]	Collection of information that identifies a fax number, as defined by telecom services.
URLAdr - URLAddress	[0..1]	Address for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.
EmailAdr - EmailAddress	[0..1]	Address for electronic mail (e-mail).
EmailPurp - EmailPurpose	[0..1]	Purpose for which an email address may be used.
JobTitl - JobTitle	[0..1]	Title of the function.
Rspnsblty - Responsibility	[0..1]	Role of a person in an organisation.
Dept - Department	[0..1]	Identification of a division of a large organisation or building.
Othr - OtherContact	[0..1]	Contact details in another form.
ChanlTp - ChannelType	[0..1]	Method used to contact the financial institution's contact for the specific tax region.
Id - Identifier	[0..1]	Communication value such as phone number or email address.
PrefrdMtd - PreferredContactMethod	[0..1]	Preferred method used to reach the contact.
Rsn - Reason	[1..1]	Specifies the reason for the status report.
Cd - Code	[1..1]	Reason for the status, as published in an external reason code list.
Prtry - Proprietary	[1..1]	Reason for the status, in a proprietary form.
AddtlInf - AdditionalInformation	[0..1]	Additional information about the status report.
ChrgsInf - Charges16	[0..0]	NOTE: Unsure on description. Seemingly a generic schema for charges, with an amount, agent, and type.
AccptncDtTm - ISODateTime	[0..1]	Date and time at which the status was accepted.
PrcgDt - DateAndDateTime2Choice	[0..1]	Date/time at which the instruction was processed by the specified party.
Dt - Date	[0..1]	Specified date.
DtTm - DateTime	[0..1]	Specified date and time.
FctvIntrBkSttlmDt - DateAndDateTime2Choice	[0..0]	Specifies the reason for the status.
AcctSvcrRef - Max35Text	[0..1]	Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.
ClrSysRef - Max35Text	[0..1]	Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.
InstgAgt - BranchAndFinancialInstitutionIdentification8	[0..0]	Unique and unambiguous identification of a financial institution or a branch of a financial institution.
InstdAgt - BranchAndFinancialInstitutionIdentification8	[0..0]	Unique and unambiguous identification of a financial institution or a branch of a financial institution.
OrgnlTxRef - OriginalTransactionReference42	[0..0]
SplmtryData - SupplementaryData1	[0..1]	Additional information that cannot be captured in the structured elements and/or any other specific block.
PlcAndNm - PlaceAndName	[0..1]	Unambiguous reference to the location where the supplementary data must be inserted in the message instance.
Envlp - Envelope	[0..1]	Technical element wrapping the supplementary data. Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
SplmtryData - SupplementaryData1	[0..1]	Additional information that cannot be captured in the structured elements and/or any other specific block.
PlcAndNm - PlaceAndName	[0..1]	Unambiguous reference to the location where the supplementary data must be inserted in the message instance.
Envlp - Envelope	[0..1]	Technical element wrapping the supplementary data. Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.