Payment status - Freedom Pay

Request

Path Params

id

integer

required

Unique identifier of the payment order.
The body of the ISO20022 document must be in XML format and must comply with the XSD schema specified in the configuration.
Can be vacuumed before you take it to the service center.
https://www.liquid-technologies.com/online-xsd-validator

Example:

OrgnlInstrId

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/xml

XML Tag	Field Name	Value / Description
CstmrPmtStsRpt/GrpHdr/MsgId	Message ID	REPLY-20250611-0001 — unique status report ID
CstmrPmtStsRpt/GrpHdr/CreDtTm	Create Date Time	2025-06-11T15:30:00Z — report creation date/time
CstmrPmtStsRpt/OrgnlGrpInfAndSts/OrgnlMsgId	Original Message ID	CLIENT-PAIN-0001 — ID of the original message (pain.001)
CstmrPmtStsRpt/OrgnlGrpInfAndSts/OrgnlMsgNmId	Original Message Name ID	pain.001.001.12 — type of the original message
CstmrPmtStsRpt/OrgnlGrpInfAndSts/GrpSts	Group Status	PART — partially processed
CstmrPmtStsRpt/OrgnlPmtInfAndSts/OrgnlPmtInfId	Original Payment Info ID	PMT-001 — ID of the payment info section from pain.001
CstmrPmtStsRpt/OrgnlPmtInfAndSts/TxInfAndSts/OrgnlInstrId	Original Instruction ID	Unique platform id
CstmrPmtStsRpt/OrgnlPmtInfAndSts/TxInfAndSts/OrgnlEndToEndId	Original End-to-End ID	E2E-20240611-01 — unique transaction ID from pain.001
CstmrPmtStsRpt/OrgnlPmtInfAndSts/TxInfAndSts/TxSts	Transaction Status	RJCT — rejected
CstmrPmtStsRpt/OrgnlPmtInfAndSts/TxInfAndSts/StsRsnInf/Rsn/Cd	Status Reason Code	AC01 — invalid account number (per ISO 20022)
CstmrPmtStsRpt/OrgnlPmtInfAndSts/TxInfAndSts/StsRsnInf/	Additional Information	IBAN is invalid or missing — description of the rejection reason

Body

object {0}

Example

{
  "status": "success",
  "error_code": 0,
  "error_description": 0,
  "document_type": "iso20022",
  "document_body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Document xmlns=\"urn:iso:std:iso:20022:tech:xsd:pain.002.001.14\">\n  <CstmrPmtStsRpt>\n    <GrpHdr>\n      <MsgId>7LTLtytmVQVC901t8XZbQcc2h</MsgId>\n      <CreDtTm>2025-06-16T09:31:49+00:00</CreDtTm>\n    </GrpHdr>\n    <OrgnlGrpInfAndSts>\n      <OrgnlMsgId>14</OrgnlMsgId>\n      <OrgnlMsgNmId>pain.001.001.14</OrgnlMsgNmId>\n      <GrpSts>PART</GrpSts>\n    </OrgnlGrpInfAndSts>\n    <OrgnlPmtInfAndSts>\n      <OrgnlPmtInfId>PMT-001</OrgnlPmtInfId>\n      <TxInfAndSts>\n        <OrgnlInstrId>12345</OrgnlInstrId>\n    <OrgnlEndToEndId>INV-003</OrgnlEndToEndId>\n        <TxSts>PDNG</TxSts>\n      </TxInfAndSts>\n    </OrgnlPmtInfAndSts>\n  </CstmrPmtStsRpt>\n</Document>",
  "dt": "2025-06-16T09:31:49+00:00"
}