ARS — Address Resolution Service

ProcessMessageResponse

object
decisionstring

Top-level processing decision.

Allowed values:ACCEPTREJECTPARTIAL_SUCCESS

messageTypestring

ISO 20022 message type. R-transaction types (pain.002, pain.007, pacs.002,
pacs.004, camt.029, camt.052, camt.053, camt.054, camt.055, camt.056, camt.058, camt.110, camt.111) must be submitted to R-transaction endpoints only
(EP-07, EP-15). Submitting them to Check/Convert endpoints returns HTTP 422 (REG-06).

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

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

discoveredAddressesinteger
resultsarray

Full address processing result object (used in EP-01 and all Layer 1 responses).

Show Child Parameters
statisticsobject

Processing statistics block returned on all endpoints.

Show Child Parameters
issuesarray[object]

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

Show Child Parameters
timestampstring(date-time)
Example

ProcessBatchMessageRequest

object

EP-09 batch request. Up to 100 messages per call.

channelNamestring
messagesarray[object]required

<= 100 items

Show Child Parameters
contextobject

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
Example

ProcessBatchMessageResponse

object
decisionstring

Top-level processing decision.

Allowed values:ACCEPTREJECTPARTIAL_SUCCESS

messageResultsarray[object]
Show Child Parameters
statisticsobject

Processing statistics block returned on all endpoints.

Show Child Parameters
timestampstring(date-time)
Example

CheckMessageRequest

object

EP-10 request. Structural PreCheck on all party addresses in message.

channelNamestring
messageContentobject
messageXmlstring
processingOptionsobject

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
contextobject

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
Example

CheckMessageResponse

object
messageStatusstring

Outcome of structural pre-check validation.

Allowed values:COMPLIANTNOT_COMPLIANT

compliantCountinteger
nonCompliantCountinteger
discoveredAddressesinteger
resultsarray[object]
Show Child Parameters
timestampstring(date-time)
Example