7.15 PUT /transfers/{ID}

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

Context

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

This message is a response to the POST \transfers call initiated by the DFSP who is requesting to proceed with the transfer terms presented in the PUT \quotes. It is the payee DFSPs responsibility to check that the clearing amounts align with the agreed transfer terms, and if all requirements are met, this message is used to lock-in the agreed terms. Once the hub receives this acceptance message, the transfer can no-longer timeout and will be committed. If this transfer is a dependent transfer in a currency conversion, then that currency conversion will be committed at the same time as this transfer.

The cryptographic ILP fulfillment provided in the TxInfAndSts.ExctnConf field, is released by the payee DFSP as an indication to the HUB that the terms have been met.

Here is an example of the message:

{
"GrpHdr": {
    "MsgId":"01JBVM1CGC5A18XQVYYRF68FD1",
    "CreDtTm":"2024-11-04T12:57:45.228Z"},
"TxInfAndSts":{
    "ExctnConf":"ou1887jmG-l...",
    "PrcgDt":{
        "DtTm":"2024-11-04T12:57:45.213Z"},
    "TxSts":"RESV"}
}

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 - GroupHeader113	[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.
BtchBookg - BatchBookingIndicator	[0..0]
NbOfTxs - Max15NumericText	[0..0]	Specifies a numeric string with a maximum length of 15 digits.
CtrlSum - DecimalNumber	[0..0]
TtlIntrBkSttlmAmt - ActiveCurrencyAndAmount	[0..0]	A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
IntrBkSttlmDt - ISODate	[0..0]	A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
SttlmInf - SettlementInstruction15	[0..0]	Only the CLRG: Clearing option is supported. Specifies the details on how the settlement of the original transaction(s) between the instructing agent and the instructed agent was completed.
PmtTpInf - PaymentTypeInformation28	[0..0]	Provides further details of the type of payment.
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.
CdtTrfTxInf - CreditTransferTransaction64	[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.