Get the original ISO 20022 source message
GET/v1/iso20022/messages/:uetr/source
Return the exact bytes of the pacs.009 message that was submitted for this UETR, in
application/iso20022+xml. The sending bank and the receiving bank can both read it, for
example so that the receiving bank can see the ordering details (such as Dbtr and Cdtr)
that the platform itself does not use.
Required scope: connector:transfers:read.
Send Accept: application/iso20022+xml (or application/*, */*, or no Accept header);
anything else is rejected with 406.
The message is available as soon as the submission has been accepted, whatever the state of
the transfer. It is stored encrypted, and each bank's copy is decrypted with that bank's own
registered key-encryption key for source messages. Before the message is returned, its
SHA-256 digest is checked against the digest recorded at submission; the SHA-256 of the
returned body therefore equals the Fingerprint a preflight of the same message reports.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 406
- 424
- 429
- 500
- 503
The original message, byte for byte as submitted.
Response Headers
Sent by the ISO 20022 endpoints only. Identifier (a UUID) of the operation that tracks this request.
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.
The uetr path parameter is not a UUID version 4.
Error, returned as an XML problem document (application/problem+xml). The HTTP status
code is repeated in <status>; each <error> carries a <title> and, where one applies,
a <code> and a <detail>.
The token lacks connector:transfers:read or is not scoped to the bank, or the bank is
suspended or terminated.
No ISO 20022 payment with this UETR exists for which the calling bank is the sender or the receiver. The response is identical whether the UETR does not exist or belongs to other banks.
The Accept header does not allow application/iso20022+xml (accepted values are
application/iso20022+xml, application/* and */*, with a quality above 0). Note that
application/xml alone is not accepted.
Your bank's key-encryption key cannot be used to decrypt the message
(KEY_UNAVAILABLE). The detail says whether to restore the platform's permission to use
the key, or to re-enable the key or cancel its deletion; the message can only be decrypted
with that key.
Error, returned as an XML problem document (application/problem+xml). The HTTP status
code is repeated in <status>; each <error> carries a <title> and, where one applies,
a <code> and a <detail>.
The stored message failed its integrity check (INTEGRITY_CHECK_FAILED) or an internal
error occurred. Contact the network operator.
The key provider, object store or workflow service is temporarily unavailable
(DEPENDENCY_UNAVAILABLE or Workflow unavailable); retry later.