ISO 20022 Messages

ISO 20022 messages are submitted to Nexus via asynchronous API.

The ISO 20022 XML message itself will be included in full in the message body.

The Source IPSO will also define an endpoint to which Nexus should send the resulting response (ie when submitting acmt.023, the Source IPSO must also define the acmt024Endpoint to which Nexus should send the acmt.024 response).

Submit ISO 20022 acmt.023 message (Proxy or Account Resolution Request)

post

This endpoint accepts an ISO 20022 acmt.023 message in XML format. The message must be prepared according to the Nexus Message Usage Guidelines.

Query parameters

acmt024Endpointstring · uriRequired

An API URL exposed by the Source IPSO where the acmt.024 response (which contains underlying account details) should be sent.

Body

stringOptionalExample: [Full XML of the acmt.023 request]

Responses

200

Successful response

application/xml

ResponsestringExample: [Full XML of the acmt.024 response]

post

HTTPcURLJavaScriptPython

POST /iso20022/acmt023 HTTP/1.1
Host: localhost:3000
Content-Type: application/xml
Accept: */*
Content-Length: 36

"[Full XML of the acmt.023 request]"

200

Successful response

<?xml version="1.0"?>
<object>[Full XML of the acmt.024 response]</object>

Submit ISO 20022 pacs.008 message (FI to FI Customer Credit Transfer - the core Nexus payment instruction)

post

This endpoint accepts an ISO 20022 pacs.008 message in XML format. The message must be prepared according to the Nexus Message Usage Guidelines.

Query parameters

pacs002Endpointstring · uriRequired

An API endpoint exposed by the Source IPSO where the pacs.002 response (Payment Status Report) should be sent.

Body

stringOptionalExample: [Full XML of the pacs.008 request]

Responses

200

Successful response

application/xml

ResponsestringExample: [Full XML of the pacs.002 response]

post

HTTPcURLJavaScriptPython

POST /iso20022/pacs008 HTTP/1.1
Host: localhost:3000
Content-Type: application/xml
Accept: */*
Content-Length: 36

"[Full XML of the pacs.008 request]"

200

Successful response

<?xml version="1.0"?>
<object>[Full XML of the pacs.002 response]</object>