ARS — Address Resolution Service

Context

object

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.

namestring

Analytics only. ISO 20022 party name used for entity conflict detection.

schemestring

Analytics + Processing fallback. Payment scheme.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

schemeVersionstring

Analytics + Processing fallback. SR2025 or SR2026. Controls post-cutover enforcement.

Allowed values:SR2025SR2026

executionDatetimestring(date-time)

Analytics + Processing fallback. Payment execution datetime in ISO 8601 UTC. Used for SR2026 cutover enforcement (cutover = 2026-11-22T02:30:00Z).

directionstring

Analytics + Processing fallback. OUTBOUND | INBOUND.

Allowed values:OUTBOUNDINBOUND

partyRolestring

Analytics + Processing fallback. Party role for this request.

Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party

outputModestring

Analytics + Processing fallback. Address line rendering constraints.

Allowed values:EPCCBPR_PLUSMT_LEGACYCOMPLIANCE

sendingCountrystring

Analytics + Processing fallback. Country of the sending PSP (ISO 3166-1 alpha-2).

Match pattern:^[A-Z]{2}$

receivingCountrystring

Analytics + Processing fallback. Country of the receiving PSP.

Match pattern:^[A-Z]{2}$

messageTypestring

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

timezonestring

Analytics + Processing fallback. IANA timezone for executionDatetime evaluation.

inputFormatstring

Analytics only. Format of the originating input.

Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

outputFormatstring

Analytics only. Expected output format.

Allowed values:FULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

sourcestring

Analytics only. Sending system identifier (e.g. PAYMENT_HUB, SWIFT_ALLIANCE).

senderstring

Analytics only. BIC of the sending institution.

receiverstring

Analytics only. BIC of the receiving institution.

paymentMethodstring

Analytics only. Payment method for audit reporting.

channelstring

Analytics only. Delivery channel for audit.

Allowed values:apifileother

applicationstring

Analytics only. Caller application identifier.

referencestring

Analytics only. Business reference for audit trail (e.g. payment ID, batch ID).

partyTypestring

Analytics only. Whether the party is a company or individual.

Allowed values:COMPANYINDIVIDUAL

Example

ReasonCode

object

Structured reason code. Prefix indicates category:
FMT = format, FLD = field, REG = regulatory, ENT = entity, VRF = verification, CNV = conversion.

codestringrequired

Reason code in PREFIX-NN format (e.g. FMT-01, REG-05, VRF-03).

Example:REG-05

severitystringrequired

Severity level.

Allowed values:ERRORWARNINGINFO

fieldstring

ISO 20022 field name the reason applies to (e.g. TownName, AddressLine).

messagestringrequired

Human-readable explanation.

ruleSourcestring

Regulatory reference (e.g. EPC SCT Rulebook §3.4, CBPR+ MP §2.1).

Example

Issue

object

Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.

severitystring

Allowed values:ERRORWARNINGINFO

codestring
messagestring
fieldstring
Example

Statistics

object

Processing statistics block returned on all endpoints.

processingTimeMsinteger

Total processing time in milliseconds.

totalRecordsinteger

Total number of records submitted.

processedRecordsinteger

Number of records successfully processed.

acceptedCountinteger
rejectedCountinteger
Example

RTransactionContext

object

R-transaction exemption assessment result.

exemptionApplicableboolean

TRUE if original predates SR2026 cutover and exemption applies; FALSE if postdates; null if originalExecutionDatetime not provided.

cutoverDatetimestring(date-time)

Always 2026-11-22T02:30:00Z — the SR2026 cutover reference datetime.

Example:2026-11-22T02:30:00Z

originalIsPreCutoverboolean

TRUE if the original payment execution datetime predates the SR2026 cutover.

Example