schemestringrequired
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
EP-21 — Scheme Message Types
Returns message types for the specified scheme with party role XPaths,
PostalAddress24 variants, and mandate flags.
Static mandate flag: true for OCT Inst payer. Context-dependent mandates use EP-16/EP-17.
Returns HTTP 404 if scheme code not recognised.
get
https://api-uat.ionova.ai/ars/schemes/{scheme}/message-types
Path Parameters
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Response
application/json
Response
application/json
Scheme message types returned
SchemeMessageTypesResponse
schemestring
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
messageTypesarray[object]
Show Child Parameters
get/schemes/{scheme}/message-types
Authentication
Path Parameters
Headers
application/json
Layer 5 — Config
Account profile and channelProfile management.
EP-22 — Get Profile
Returns the complete account-level profile: account_id, region, community,
formatLimits, and channelProfiles[] summary.
[v4.3] Channel-specific settings (scheme, schemeVersion, direction, outputMode,
targetFormat, quality, timezone, repairConfidenceThreshold) are managed via
channelProfile endpoints (EP-25/EP-26/EP-27). Only institutional fallbacks remain here.
get
https://api-uat.ionova.ai/ars/profile
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Response
application/json
Response
application/json
Profile returned
ProfileResponse
Account-level profile. Contains institutional fallback settings and
a listing of all registered channelProfiles.
[v4.3] scheme, schemeVersion, direction, targetFormat, autoRepairMode,
pspCountry, timezone, quality, repairConfidenceThreshold have been moved
to channelProfile. The account profile now retains only institution-level
fallback values (pspCountry, timezone, quality, repairConfidenceThreshold).
account_idstring
Unique account identifier.
Example:acc_8f2a91bc
regionstring
Deployment region for data residency (EU-based data centres).
Example:europe_sepa
communitystring
Account community / tier classification. System-assigned.
Example:premium_tier
formatLimitsobject
Default address line count and length limits for the account.
Show Child Parameters
channelProfilesarray[object]
Summary entry for a channelProfile in the account profile listing.
Show Child Parameters
get/profile
Authentication
Headers
application/json
EP-23 — Update Profile
Updates account-level fields using PATCH semantics — only provided fields updated.
Changes take effect immediately.
[v4.3] Only account-level institutional fallback fields patchable here:
region, pspCountry, timezone, quality, repairConfidenceThreshold.
Channel-specific settings must be managed via EP-25/EP-26.
patch
https://api-uat.ionova.ai/ars/profile
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
UpdateProfileRequest
PATCH body for EP-23. Only account-level fields are patchable here.
[v4.3] Channel-specific settings (scheme, schemeVersion, direction, outputMode,
autoRepairMode, targetFormat) are now managed via EP-26 channelProfile PATCH.
regionstring
Deployment region for data residency. One of: europe_sepa, us_east, ap_southeast.
pspCountrystring
Account-level institutional PSP country fallback (ISO 3166-1 alpha-2).
Match pattern:^[A-Z]{2}$
timezonestring
Account-level institutional timezone fallback. Overridden by channelProfile.
qualitystring
Account-level institutional quality fallback. Overridden by channelProfile.
Allowed values:premiumstandardbasic
repairConfidenceThresholdnumber
Account-level institutional confidence threshold fallback (0.0–1.0).
>= 0<= 1
Response
application/json
Response
application/json
Profile updated — full profile returned
ProfileResponse
Account-level profile. Contains institutional fallback settings and
a listing of all registered channelProfiles.
[v4.3] scheme, schemeVersion, direction, targetFormat, autoRepairMode,
pspCountry, timezone, quality, repairConfidenceThreshold have been moved
to channelProfile. The account profile now retains only institution-level
fallback values (pspCountry, timezone, quality, repairConfidenceThreshold).
account_idstring
Unique account identifier.
Example:acc_8f2a91bc
regionstring
Deployment region for data residency (EU-based data centres).
Example:europe_sepa
communitystring
Account community / tier classification. System-assigned.
Example:premium_tier
formatLimitsobject
Default address line count and length limits for the account.
Show Child Parameters
channelProfilesarray[object]
Summary entry for a channelProfile in the account profile listing.
Show Child Parameters
patch/profile
Authentication
Headers
Body
{
"region": "europe_sepa",
"pspCountry": "DE",
"timezone": "Europe/Berlin",
"quality": "standard",
"repairConfidenceThreshold": 0.8
}
application/json
EP-25 — Register Channel Profile
Registers a new named channel profile storing default processing parameters for a
specific channel/scheme/direction combination. Once registered, reference by channelName
in EP-01 through EP-17 to auto-apply all channel defaults.
channelName must be unique per account. HTTP 409 if name already exists.
Use DELETE + POST to rename. Changes via EP-26 take effect immediately for all
subsequent requests using this channelName.
post
https://api-uat.ionova.ai/ars/channel-profile
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Body
Body
CreateChannelProfileRequest
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
Response
Response
Channel profile registered
ChannelProfileResponse
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.
post/channel-profile
Authentication
Headers
Body
{
"channelName": "MY_SEPA_SCT",
"channelSelection": {
"channel": "sepa",
"scheme": "SCT",
"schemeVersion": "SR2026",
"direction": "OUTBOUND",
"pspCountry": "DE",
"timezone": "Europe/Berlin"
},
"corridor": {
"sendingCountry": "DE",
"receivingCountry": "FR",
"currency": "EUR"
},
"preferences": {
"outputMode": "EPC",
"autoRepairMode": "STANDARD",
"targetFormat": "auto",
"quality": "standard",
"repairConfidenceThreshold": 0.8
}
}