Search
K
ARS — Address Resolution Service

CreateChannelProfileRequest

object

Request body for EP-25 — Register Channel Profile.

channelNamestringrequired

Unique name for this channel profile. Must be unique per account. Use DELETE + POST to rename.

Example:CBPR_OUTBOUND_US

channelSelectionobjectrequired

Channel identification block for channelProfile registration and retrieval.

Show Child Parameters
corridorobject

Default corridor (geographic routing) block for a channelProfile.

Show Child Parameters
preferencesobject

Output and behaviour preference defaults for a channelProfile.

Show Child Parameters
Example

UpdateChannelProfileRequest

object

Request body for EP-26 — Update Channel Profile (PATCH semantics).
Only fields provided are updated. channelName cannot be changed via PATCH.

channelSelectionobject

PATCH of channelSelection block. Only provided sub-fields are updated.

Show Child Parameters
corridorobject
Show Child Parameters
preferencesobject
Show Child Parameters
Example

ChannelProfileResponse

object

Full channel profile returned by EP-25 (201), EP-26 (200), and EP-27 (200).

channelNamestring

Example:CBPR_OUTBOUND_US

channelSelectionobject

Channel identification block for channelProfile registration and retrieval.

Show Child Parameters
corridorobject

Default corridor (geographic routing) block for a channelProfile.

Show Child Parameters
preferencesobject

Output and behaviour preference defaults for a channelProfile.

Show Child Parameters
createdAtstring(date-time)

Timestamp when this channel profile was first registered.

updatedAtstring(date-time)

Timestamp when this channel profile was last updated.

Example

FormatLimits

object

Default address line count and length limits for the account.

maxLinesinteger

Default maximum address lines.

Example:3

maxLineLengthinteger

Default maximum characters per line.

Example:35

Example

ChannelProfileSummary

object

Summary entry for a channelProfile in the account profile listing.

channelNamestring
channelstring

Payment delivery channel type.

Allowed values:apifileother

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

schemeVersionstring

ISO 20022 scheme version / SR year.

Allowed values:SR2025SR2026

directionstring

Payment processing direction. OUTBOUND = sending; INBOUND = receiving.

Allowed values:OUTBOUNDINBOUND

outputModestring

Address line rendering constraints applied during output formatting.

  • EPC: 2 lines × 70 chars
  • CBPR_PLUS: 3 lines × 35 chars
  • MT_LEGACY: 2 lines × 35 chars
  • COMPLIANCE: 7 lines × 70 chars

Allowed values:EPCCBPR_PLUSMT_LEGACYCOMPLIANCE

createdAtstring(date-time)
updatedAtstring(date-time)
Example