ARS — Address Resolution Service

ExtractMessageRequest

object

EP-14 request. Extracts and inventories all party addresses in message.

channelNamestring
executionDatetimestring(date-time)
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

Provide sendingCountry and receivingCountry for accurate mandate assessment.

Show Child Parameters
includearray[string]
Example

ExtractMessageResponse

object
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
partyAddressesarray[object]
Show Child Parameters
timestampstring(date-time)
Example

RTransactionMessageRequest

object

EP-15 request. R-transaction exemption assessment for all addresses in message.

channelNamestring
originalExecutionDatetimestring(date-time)

Optional — ARS auto-extracts from message XML if not provided.

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

RTransactionMessageResponse

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

originalExecutionDatetimestring(date-time)
rTransactionContextobject

R-transaction exemption assessment result.

Show Child Parameters
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

MandatePartyAddressRequest

object

EP-16 request. Address mandate determination for a single party.
Processing precedence: channelProfile → processingOptions → context.

channelNamestringrequired

Required. Name of a registered channelProfile. Loads pspCountry, payerPspCountry, payeePspCountry, scheme, schemeVersion.

processingOptionsobject

Per-request overrides — scheme, schemeVersion, payerPspCountry, payeePspCountry.

Show Child Parameters
contextobject

Provide sendingCountry/receivingCountry as fallback for EEA determination.

Show Child Parameters
Example