Statistics
objectProcessing statistics block returned on all endpoints.
Total processing time in milliseconds.
Total number of records submitted.
Number of records successfully processed.
Records that produced one or more WARNING reasons but were not rejected.
Records that failed with an unrecoverable ERROR (distinct from rejectedCount which counts business-rule rejects).
RTransactionContext
objectR-transaction exemption assessment result.
TRUE if original predates SR2026 cutover and exemption applies; FALSE if postdates; null if originalExecutionDatetime not provided.
Always 2026-11-15T02:30:00Z — the SR2026 cutover reference datetime.
Example:2026-11-15T02:30:00Z
TRUE if the original payment execution datetime predates the SR2026 cutover.
AddressResult
objectFull address processing result object (used in EP-01 and all Layer 1 responses).
ISO 20022 party role. Determines the PostalAddress24 XSD variant:
- __2 variant (ultimate_debtor, ultimate_creditor, initiating_party):
TownName AND Country are MANDATORY. FULLY_UNSTRUCTURED is NEVER permitted (REG-005). - __1 variant (debtor, creditor):
Max 3 AddressLines. FULLY_UNSTRUCTURED is permitted until SR2026 cutover (2026-11-15T02:30:00Z) for INBOUND;
banned OUTBOUND post-cutover.
Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party
Format detected in the submitted address.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Format of the processed output address.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Outcome of AutoCorrect processing for an address.
Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED
Processed PostalAddress24 output.
Show Child Parameters
Postal DB verification result.
Show Child Parameters
Identifiers extracted from AddressLine (R-04 entity extraction).
Show Child Parameters
Party name text found embedded within address lines (R-05 PMPG non-duplication).
Overall confidence score (0.0–1.0) and per-field confidence scores.
Show Child Parameters
Canonical normalised address and SHA-256 fingerprint. Present when include contains canonical.
Show Child Parameters
TRUE if this address is exempt from SR2026 enforcement under EPC §8.3.
Structured reason code. Prefix indicates category (each family drawn from
the internal rules registry — clients should not depend on the exact
numeric value):
Customer-facing regulatory / processing families:
FMT = format-validation, FLD = field-required, REG = regulatory,
CNV = conversion, ENT = entity, VRF = verification.
Diagnostic / algorithmic families (INFO-severity only):
RFT = reformatting, INF = informational, DCT = dictionary match,
POS = positional-rule, SYN = syntax-rule, VLD = validation,
ENR = enrichment, ADP = adaptive-parser, DIC = dictionary lookup,
GLC = geo-location, PHN = phonetic, SPL = spell-correction,
VAL = validation-diagnostic.
All codes use the strict PREFIX-NNN (3-digit) format.
Show Child Parameters
MessageAddressResult
ISO 20022 party role. Determines the PostalAddress24 XSD variant:
- __2 variant (ultimate_debtor, ultimate_creditor, initiating_party):
TownName AND Country are MANDATORY. FULLY_UNSTRUCTURED is NEVER permitted (REG-005). - __1 variant (debtor, creditor):
Max 3 AddressLines. FULLY_UNSTRUCTURED is permitted until SR2026 cutover (2026-11-15T02:30:00Z) for INBOUND;
banned OUTBOUND post-cutover.
Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party
Format detected in the submitted address.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Format of the processed output address.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Outcome of AutoCorrect processing for an address.
Allowed values:VALIDATEDREPAIREDPARTIALLY_REPAIREDNOT_REPAIRED
Processed PostalAddress24 output.
Show Child Parameters
Postal DB verification result.
Show Child Parameters
Identifiers extracted from AddressLine (R-04 entity extraction).
Show Child Parameters
Party name text found embedded within address lines (R-05 PMPG non-duplication).
Overall confidence score (0.0–1.0) and per-field confidence scores.
Show Child Parameters
Canonical normalised address and SHA-256 fingerprint. Present when include contains canonical.
Show Child Parameters
TRUE if this address is exempt from SR2026 enforcement under EPC §8.3.
Structured reason code. Prefix indicates category (each family drawn from
the internal rules registry — clients should not depend on the exact
numeric value):
Customer-facing regulatory / processing families:
FMT = format-validation, FLD = field-required, REG = regulatory,
CNV = conversion, ENT = entity, VRF = verification.
Diagnostic / algorithmic families (INFO-severity only):
RFT = reformatting, INF = informational, DCT = dictionary match,
POS = positional-rule, SYN = syntax-rule, VLD = validation,
ENR = enrichment, ADP = adaptive-parser, DIC = dictionary lookup,
GLC = geo-location, PHN = phonetic, SPL = spell-correction,
VAL = validation-diagnostic.
All codes use the strict PREFIX-NNN (3-digit) format.
Show Child Parameters
XPath location of this party address within the ISO 20022 message.
PostalAddress24 XSD variant (__1 = debtor/creditor, __2 = ultimate/initiating).
Allowed values:__1__2
System-assigned per-address ID (format A0000000123). Stable within an org — safe to correlate against GET /audit/ars/addresses/{iAdrId}.
Example:A0000000123
User-supplied per-address reference (correlation ID for the caller’s own systems).
Batch-level reference — same value across every iAdrId in the same submission.
ErrorResponse
objectStandard error envelope returned on 4xx and 5xx responses.
HTTP status code.
Human-readable error description.
Correlation ID for support.