This request allows you to set the final status of a MyBank Transaction.
Typical use case
The Payer PSP must invoke this API as soon as the MyBank Transaction has reached one of the following final statuses: "AUTHORISED", "AUTHORISINGPARTYABORTED", "ERROR".
Request body attributes
The following attributes in the request body are always mandatory:
- institute, token : needed to identify the transaction
- authorisingAccessMode, authorisingUserAgent : indicate the type of client used by the Payer to access MyBank Authorisation page (please refer to the Data Items section for more information).
- transactionStatus, transactionStatusModifiedDate : final status to be assigned to the transaction, and time of assignment (typically, this is the current time).
The following attributes in the request body are mandatory if transactionStatus is "AUTHORISED":
- buyerBic, buyerIban, buyerName : indicate the Payer's account used as Originator account of the payment.
- confirmedExecutionDate : execution date of the payment.
- paymentTransactionID : TxId (generated by the Payer PSP) that will be used in the pacs.008 of the payment.
- sctInstExecuted : indicates whether the target payment instrument is Instant SCT ("1") or ordinary SCT ("0").
The following attributes in the request body are mandatory if transactionStatus is "ERROR":
- businessError
- transactionErrorInfo (although not technically mandatory, it is recommended to set this attribute in case transactionStatus is "ERROR")
Typical use of the response
n/a
It is particularly important to correctly handle the response of this API: as explained in the "Technical Overview", an HTTP status code other than 200, as well as a result other than 200 indicates an error. The Payer PSP must consider any case of unsuccessful invocation of the API as an unrecoverable technical error: in this case, the payment must not be executed.
In particular, any attempt to set the final status after the MyBank transaction has expired will result in an error.