ErrorResponse
objectStandard error envelope returned on 4xx and 5xx responses.
HTTP status code.
Human-readable error description.
Correlation ID for support.
ChannelSelection
objectChannel identification block for channelProfile registration and retrieval.
Payment delivery channel type. Required.
Allowed values:apifileother
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
ISO 20022 scheme version / SR year.
Allowed values:SR2025SR2026
Payment processing direction. OUTBOUND = sending; INBOUND = receiving.
Allowed values:OUTBOUNDINBOUND
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
Default party role. Determines PostalAddress24 XSD variant.
Allowed values:debtorcreditorultimate_debtorultimate_creditorinitiating_party
PSP home country for this channel. Overrides account-level pspCountry.
Match pattern:^[A-Z]{2}$
Default payer PSP country for EEA mandate determination.
Match pattern:^[A-Z]{2}$
Default payee PSP country for EEA mandate determination.
Match pattern:^[A-Z]{2}$
Default IANA timezone for executionDatetime evaluation (e.g. Europe/Frankfurt).
Corridor
objectDefault corridor (geographic routing) block for a channelProfile.
Default sending PSP country (ISO 3166-1 alpha-2).
Match pattern:^[A-Z]{2}$
Default receiving PSP country (ISO 3166-1 alpha-2).
Match pattern:^[A-Z]{2}$
Default transaction currency (ISO 4217, e.g. EUR, GBP, USD).
Match pattern:^[A-Z]{3}$
ChannelPreferences
objectOutput and behaviour preference defaults for a channelProfile.
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
ARS AutoCorrect repair aggressiveness level.
Allowed values:CONSERVATIVESTANDARDAGGRESSIVE
When true, force SR2026 rules even if schemeVersion=SR2025.
Target conversion format. auto lets ARS select the best achievable format.
Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED
Postal database verification depth.
Allowed values:premiumstandardbasic
Default minimum confidence score for REPAIRED classification (0.0–1.0).
>= 0<= 1
CreateChannelProfileRequest
objectRequest body for EP-25 — Register Channel Profile.
Unique name for this channel profile. Must be unique per account. Use DELETE + POST to rename.
Example:CBPR_OUTBOUND_US
Channel identification block for channelProfile registration and retrieval.
Show Child Parameters
Default corridor (geographic routing) block for a channelProfile.
Show Child Parameters
Output and behaviour preference defaults for a channelProfile.