Sign in
latestOpenAPI 3.1.02026-08-108936.3 KB

b3e625f21841

ISO 20022

Submit ISO 20022 message

Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type:

  • pacs.008 — FI to FI Customer Credit Transfer
  • pacs.002 — FI to FI Payment Status Report
  • pacs.028 — FI to FI Payment Status Request
  • acmt.023 — Identification Verification Request
  • acmt.024 — Identification Verification Report
  • camt.054 — Bank to Customer Debit Credit Notification
  • camt.056 — FI to FI Payment Cancellation Request
  • camt.029 — Resolution of Investigation
  • admi.002 — Message Reject
  • admi.004 — System Event Notification

The synchronous 202 Accepted response is a technical acknowledgement (application/json) confirming receipt and schema validation only. The business response is delivered asynchronously as an ISO 20022 message to the participant's registered endpoint (e.g. pacs.008 → asynchronous pacs.002; acmt.023 → acmt.024). Unsupported message types return 404 with an ErrorResultDto body.

post/iso20022/{messagePath}

Path parameters

messagePath'pacs.008' | 'pacs.002' | 'pacs.028' | 'acmt.023' | 'acmt.024' | 'camt.054' | 'camt.056' | 'camt.029' | 'admi.002' | 'admi.004' required

ISO 20022 message type identifier.

Response

Accepted. Technical acknowledgement confirming receipt and schema validation only; the business response follows asynchronously as an ISO 20022 message to the registered endpoint.

uetrstring

Unique End-to-end Transaction Reference echoed from the submitted message, where present.

messageType'pacs.008' | 'pacs.002' | 'pacs.028' | 'acmt.023' | 'acmt.024' | 'camt.054' | 'camt.056' | 'camt.029' | 'admi.002' | 'admi.004' required

ISO 20022 message type of the submitted message.

msgIdstring

Nexus Message Identification (MsgId). Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. Set by the Source IPSO. Fixed 35 character maximum structure: positions 1 to 8 carry the date as YYYYMMDD; position 9 carries the fixed value N identifying a Nexus transaction; position 10 carries the fixed value X reserved for future use; positions 11 to 14 carry the message type and subtype, for example PS08 for pacs.008; position 15 carries an alphanumeric value identifying the purpose of the message usage, where 1 is the default usage purpose for payment messages; positions 16 to 23 carry an 8 character sequence generated by the message sender, for example 23GH2345; positions 24 to 35 carry the organisation or PSP identifier, a BIC or local clearing member id such as SBININBBXXX or 78667, with no leading or trailing padding when shorter than 12 characters.

receivedAtstring date-time required

Timestamp at which the message was received by the gateway.

status'RECEIVED' | 'REJECTED' required

Technical acceptance status. RECEIVED confirms schema-valid receipt; the business outcome follows asynchronously.

ackCodestring

Technical acknowledgement code.