codestringrequired
ISO 3166-1 alpha-2 country code (e.g. DE, GB, CH)
Match pattern:^[A-Z]{2}$
Example:DE
EP-19 — Country Detail
Returns full country detail including PMPG element usage indicators for all
14 PostalAddress24 structured fields. Returns HTTP 404 if code not found.
get
https://api-uat.ionova.ai/ars/countries/{code}
Path Parameters
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Response
application/json
Response
application/json
Country detail returned
CountryDetailResponse
codestring
Match pattern:^[A-Z]{2}$
namestring
sepaMemberboolean
eeaMemberboolean
elementUsageobject
PMPG usage indicators for all 14 PostalAddress24 structured fields. M=Mandatory, E=Expected, O=Optional, C=Conditional, N=Not used.
Show Child Parameters
get/countries/{code}
Authentication
Path Parameters
Headers
application/json
EP-20 — Schemes
Returns all 11 payment schemes supported by ARS v4.3. No request body. Cache aggressively.
get
https://api-uat.ionova.ai/ars/schemes
Headers
X-Request-IDstring(uuid)
Client-supplied correlation ID echoed in response headers for tracing.
Response
application/json
Response
application/json
Scheme list returned
SchemesResponse
schemesarray[object]
Show Child Parameters
get/schemes
Authentication
Headers
application/json
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
schemestringrequired
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
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