PostalAddressXml
objectISO 20022 XML tag equivalents of PostalAddress. Alternative input format — clients
may supply either postalAddress (JSON) or postalAddressXml (XML tag names), not both.
<= 70 characters<= 7 items
<= 70 characters
<= 16 characters
<= 35 characters
<= 70 characters
<= 16 characters
<= 70 characters
<= 16 characters
<= 35 characters
<= 35 characters
<= 35 characters
<= 35 characters
Match pattern:^[A-Z]{2}$
Match pattern:^[A-Z]{2}$
Identification
objectOptional party identifiers. Used for entity conflict detection (R-04).
Show Child Parameters
Show Child Parameters
ProcessingOptions
objectPer-request overrides of the channelProfile configuration. Only fields present
here override the corresponding channelProfile value. Fields absent here fall
through to channelProfile. This is NOT a general-purpose configuration block —
it only overrides values already set in channelProfile.
Per-request override of channelProfile.scheme.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
Per-request override of channelProfile.schemeVersion. SR2025 or SR2026.
Allowed values:SR2025SR2026
Per-request override of channelProfile.quality.
Allowed values:premiumstandardbasic
Per-request override. When false, skips postal DB lookup. Forced false for Basic quality.
Per-request override. When true, flags BIC/LEI/IBAN found in AddressLine (R-04).
Per-request override. When true, checks for party name duplication in address lines (R-05).
Per-request override. PII redaction level applied to response address fields.
Allowed values:NONEPARTIALFULL
Per-request override of channelProfile default targetFormat.
Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Per-request override of channelProfile.repairConfidenceThreshold (0.0–1.0).
>= 0<= 1
Per-request override of channelProfile.payerPspCountry. ISO 3166-1 alpha-2.
Match pattern:^[A-Z]{2}$
Per-request override of channelProfile.payeePspCountry. ISO 3166-1 alpha-2.
Match pattern:^[A-Z]{2}$
Context
objectAnalytics/audit passthrough AND processing fallback layer.
Fields labelled “Analytics + Processing fallback” are used as last-resort defaults
when both channelProfile and processingOptions leave a parameter unresolved.
Pure analytics fields are written to the ARS audit log but do not affect processing.
Processing precedence: channelProfile → processingOptions → context.
Analytics only. ISO 20022 party name used for entity conflict detection.
Analytics + Processing fallback. Payment scheme.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
Analytics + Processing fallback. SR2025 or SR2026. Controls post-cutover enforcement.
Allowed values:SR2025SR2026
Analytics + Processing fallback. Payment execution datetime in ISO 8601 UTC. Used for SR2026 cutover enforcement (cutover = 2026-11-15T02:30:00Z).
Analytics + Processing fallback. OUTBOUND | INBOUND.
Allowed values:OUTBOUNDINBOUND
Analytics + Processing fallback. Party role for this request.
Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party
Analytics + Processing fallback. Address line rendering constraints.
Allowed values:EPCCBPR_PLUSMT_LEGACYCOMPLIANCE
Analytics + Processing fallback. Country of the sending PSP (ISO 3166-1 alpha-2).
Match pattern:^[A-Z]{2}$
Analytics + Processing fallback. Country of the receiving PSP.
Match pattern:^[A-Z]{2}$
Analytics + Processing fallback. ISO 20022 message type.
Allowed values:pain.001pain.002pain.007pain.008pacs.002pacs.003pacs.004pacs.008pacs.009pacs.010camt.029camt.052camt.053camt.054camt.055camt.056camt.057camt.058camt.060camt.105camt.106camt.107camt.108camt.109camt.110camt.111
Analytics + Processing fallback. IANA timezone for executionDatetime evaluation.
Analytics only. Format of the originating input.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Analytics only. Expected output format.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Analytics only. Sending system identifier (e.g. PAYMENT_HUB, SWIFT_ALLIANCE).
Analytics only. BIC of the sending institution.
Analytics only. BIC of the receiving institution.
Analytics only. Payment method for audit reporting.
Analytics only. Delivery channel for audit.
Allowed values:apifileother
Analytics only. Caller application identifier.
Analytics only. Business reference for audit trail (e.g. payment ID, batch ID).
Analytics only. Whether the party is a company or individual.
Allowed values:COMPANYINDIVIDUAL
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