ReasonCode
objectStructured 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.
Reason code in the strict PREFIX-NNN (3-letter prefix, hyphen,
3-digit number) format. Examples: FMT-001 (format-validation
ERROR), REG-005 (regulatory), CNV-008 (conversion),
INF-107 (informational diagnostic). Clients should treat the
whole code as an opaque identifier and match on the full string.
Match pattern:^[A-Z]{3}-\d{3}$
Example:REG-005
Severity level.
Allowed values:ERRORWARNINGINFO
ISO 20022 field name the reason applies to (e.g. TownName, AddressLine).
Human-readable explanation.
Regulatory reference (e.g. EPC SCT Rulebook §3.4, CBPR+ MP §2.1).
0-based index of the addressLine[] entry the reason came from. Populated only when field == “addressLine”.
Where the rule applies. Useful for filtering by processing phase.
Allowed values:PreCheckAutoCorrectBoth
Fields that fed into this reason. Aids caller in identifying which inputs to fix.
Example:streetName, buildingNumber
Issue
objectLegacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.
Allowed values:ERRORWARNINGINFO
ISO 20022 XML tag the issue anchors to (e.g. TwnNm, PstCd, AdrLine).
Example:TwnNm
Regulation or rulebook reference (e.g. EPC153-22 §7, PMPG v1.11 §5).
Example:EPC153-22 §7
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.