Search
K
ARS — Address Resolution Service

Decision

string

Top-level processing decision.

Allowed values:ACCEPTREJECTPARTIAL_SUCCESS

MessageType

string

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

ChannelType

string

Payment delivery channel type.

Allowed values:apifileother

PostalAddress

object

ISO 20022 PostalAddress24 object. All 14 structured fields are supported.
Country is strongly recommended for all submissions.
AddressLine is limited to max 7 elements in schema; practical publishing limits
are governed by OutputMode (EPC=2, CBPR_PLUS=3, MT_LEGACY=2, COMPLIANCE=7).
PMPG non-duplication rule: structured fields (TownName, Country) must NOT also
appear in AddressLine simultaneously.

addressLinearray[string]

Unstructured address lines (max 70 chars each). Max 3 for __1 variant parties, max 2 for __2 variant parties.

<= 70 characters<= 7 items

streetNamestring

<= 70 characters

buildingNumberstring

<= 16 characters

buildingNamestring

<= 35 characters

floorstring

<= 70 characters

postBoxstring

<= 16 characters

roomstring

<= 70 characters

postCodestring

<= 16 characters

townNamestring

Required for __2 variant parties (ultimate_debtor, ultimate_creditor, initiating_party). Best practice for all.

<= 35 characters

townLocationNamestring

<= 35 characters

districtNamestring

<= 35 characters

countrySubDivisionstring

<= 35 characters

countrystring

ISO 3166-1 alpha-2. Strongly recommended. Required for __2 variant parties.

Match pattern:^[A-Z]{2}$

countryOfResidencestring

ISO 3166-1 alpha-2. Country where the party is resident. Distinct from country in the postal address.

Match pattern:^[A-Z]{2}$

Example

PostalAddressXml

object

ISO 20022 XML tag equivalents of PostalAddress. Alternative input format — clients
may supply either postalAddress (JSON) or postalAddressXml (XML tag names), not both.

AdrLinearray[string]

<= 70 characters<= 7 items

StrtNmstring

<= 70 characters

BldgNbstring

<= 16 characters

BldgNmstring

<= 35 characters

Flrstring

<= 70 characters

PstBxstring

<= 16 characters

Roomstring

<= 70 characters

PstCdstring

<= 16 characters

TwnNmstring

<= 35 characters

TwnLctnNmstring

<= 35 characters

DstrctNmstring

<= 35 characters

CtrySubDvsnstring

<= 35 characters

Ctrystring

Match pattern:^[A-Z]{2}$

CtryOfResstring

Match pattern:^[A-Z]{2}$

Example