Skip to main content

Get the pacs.002 payment status for a UETR

GET 
/v1/iso20022/messages/:uetr

Return the current status of a payment submitted through POST /v1/iso20022/messages, as an ISO 20022 pacs.002.001.12 (FI to FI Payment Status Report) document in application/iso20022+xml. Both the sending bank and the receiving bank can read it.

Required scope: connector:transfers:read.

Send Accept: application/iso20022+xml (or application/*, */*, or no Accept header); anything else is rejected with 406.

Status codes and group status​

The HTTP status tells you whether the payment has finished:

Operation stateHTTP statusGrpSts
ACCEPTED, PROCESSING, AWAITING_SCREENING, PENDING_REVIEW, PENDING_COMMITS, MANUAL_REVIEW, CANCELLING202 AcceptedPDNG (pending)
SUCCEEDED200 OKACCP (accepted)
REJECTED, FAILED, CANCELLED, EXPIRED, UNKNOWN200 OKRJCT (rejected)

Keep polling while you receive 202; a 200 is final. For a rejected payment with a recorded failure reason, TxInfAndSts/StsRsnInf carries an ISO 20022 ExternalStatusReason1Code and, in AddtlInf, the platform's failure message:

Rsn/CdMeaning
MS02Rejected by the receiving bank during beneficiary screening.
MS03Rejected by a checker in an approval review.
AB05Beneficiary screening was not completed in time.
AG07Settlement failed after the transfer had been accepted.
NARRAny other failure; see AddtlInf.

Report contents​

ElementContent
GrpHdr/MsgIdThe platform operation id without hyphens (32 hex characters).
GrpHdr/CreDtTmUTC time the report was generated, without a zone designator.
OrgnlGrpInfAndSts/OrgnlMsgIdThe UETR without hyphens. This is not the GrpHdr/MsgId of your original message.
OrgnlGrpInfAndSts/OrgnlMsgNmIdAlways pacs.009.001.08.
OrgnlGrpInfAndSts/GrpStsPDNG, ACCP or RJCT, as above.
TxInfAndSts/OrgnlUETRThe UETR.
TxInfAndSts/StsRsnInfOnly for RJCT with a recorded failure reason.

Every report is validated against the pacs.002.001.12 XSD before it is returned. The X-DAN-Operation-Id header gives the operation id in UUID form, for use with GET /v1/operations/{operation_id}.

Responses are sent without indentation; the examples are indented for readability.

Request​

Responses​

Final pacs.002.001.12 status report (GrpSts is ACCP or RJCT).

Response Headers
    X-DAN-Operation-Id

    Sent by the ISO 20022 endpoints only. Identifier (a UUID) of the operation that tracks this request.

    X-ISO20022-UETR

    UETR (Unique End-to-end Transaction Reference) of the payment this response refers to: a lowercase, hyphenated UUID version 4, taken from PmtId/UETR of the submitted pacs.009 message. The platform never assigns a UETR; it always echoes the one the sending bank chose.