MessageRequestBase
objectCommon fields shared by all Layer 2 message-level endpoints.
Name of a registered channelProfile. Loads scheme, direction, outputMode, and other defaults.
Transaction execution datetime for SR2026 cutover enforcement.
JSON equivalent of the ISO 20022 message. One of messageContent or messageXml required.
Raw ISO 20022 XML string. Takes precedence over messageContent if both provided.
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
ProcessMessageRequest
EP-08 request. Full ARS AutoCorrect on all party addresses in an ISO 20022 message.
Name of a registered channelProfile. Loads scheme, direction, outputMode, and other defaults.
Transaction execution datetime for SR2026 cutover enforcement.
JSON equivalent of the ISO 20022 message. One of messageContent or messageXml required.
Raw ISO 20022 XML string. Takes precedence over messageContent if both provided.
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
ProcessMessageResponse
objectTop-level processing decision.
Allowed values:ACCEPTREJECTPARTIAL_SUCCESS
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
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
Full address processing result object (used in EP-01 and all Layer 1 responses).
Show Child Parameters
Processing statistics block returned on all endpoints.
Show Child Parameters
Legacy issue object. Preserved for backward compatibility with v4.0 integrations.
New integrations should use reasons[] instead.
Show Child Parameters
ProcessBatchMessageRequest
objectEP-09 batch request. Up to 100 messages per call.
<= 100 items
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
ProcessBatchMessageResponse
objectTop-level processing decision.
Allowed values:ACCEPTREJECTPARTIAL_SUCCESS
Show Child Parameters
Processing statistics block returned on all endpoints.