ConvertOutput
objectSupplementary conversion output. Populated on EP-04 responses when the caller needs to
distinguish between the target format they asked for and the fallback the engine used
(e.g. targetFormat=FULLY_STRUCTURED but engine could only reach HYBRID).
Payment processing direction. OUTBOUND = sending; INBOUND = receiving.
Allowed values:OUTBOUNDINBOUND
Target format the engine attempted (before fallback).
Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Detected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
RenderPartyAddressRequest
objectEP-05 request. Formats address into unstructured lines per OutputMode limits.
ISO 20022 party name. Included in rendered output when present.
ISO 20022 PostalAddress24 object. All 14 structured fields plus the three
ISO 20022 identity sub-fields (addressType, department, subDepartment) are
supported. Country is strongly recommended for all submissions. AddressLine
is limited to max 7 elements in schema; practical publishing limits are
governed by OutputMode (EPC=2, CBPR_PLUS=3, MT_LEGACY=2, COMPLIANCE=7).
PMPG non-duplication rule: structured fields (TownName, Country) must NOT
also appear in AddressLine simultaneously.
Show Child Parameters
ISO 20022 XML tag equivalents of PostalAddress. Alternative input format — clients
may supply either postalAddress (JSON) or postalAddressXml (XML tag names), not both.
Show Child Parameters
Maximum output lines. Overrides channelProfile format limits.
Maximum chars per output line. Overrides channelProfile. Default 35.
Per-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.
Show Child Parameters
Analytics/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.
Show Child Parameters
RenderPartyAddressResponse
objectAllowed values:ACCEPTPARTIAL_SUCCESS
Show Child Parameters
Processing statistics block returned on all endpoints.
Show Child Parameters
ClassifyPartyAddressRequest
objectEP-06 request. Lightweight classification only — no repair.
ISO 20022 PostalAddress24 object. All 14 structured fields plus the three
ISO 20022 identity sub-fields (addressType, department, subDepartment) are
supported. Country is strongly recommended for all submissions. AddressLine
is limited to max 7 elements in schema; practical publishing limits are
governed by OutputMode (EPC=2, CBPR_PLUS=3, MT_LEGACY=2, COMPLIANCE=7).
PMPG non-duplication rule: structured fields (TownName, Country) must NOT
also appear in AddressLine simultaneously.
Show Child Parameters
ISO 20022 XML tag equivalents of PostalAddress. Alternative input format — clients
may supply either postalAddress (JSON) or postalAddressXml (XML tag names), not both.
Show Child Parameters
Analytics only for this endpoint — no processing fallback.
Show Child Parameters
ClassifyPartyAddressResponse
objectDetected or target address format classification.
Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Soft warnings from the classifier (non-blocking). Empty when nothing to flag.