{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-epc/epc.sidebars.yaml","oas-openapi/epc-cicd/epc-elpapi-partner-redoc.yaml":"oas-openapi/epc-cicd/epc-elpapi-partner-redoc.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","json-schema","openapi-code-sample"]},"type":"markdown"},"seo":{"title":"Receive PayShap with Auto-Auth","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"receive-payshap-with-auto-auth"},"children":["Receive PayShap with Auto-Auth"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"NOTE"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page describes how to receive a PayShap payment for which authorisation by the corporate client ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["is not"]}," required."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The diagram below describes the complete transaction journey for a successful proxy-based PayShap payment that you will receive."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/epc-payshap-auto-auth.1daef84f53e8ca44204446937fc5fedcec470f931a34cb5560c7c54a892652fa.9c1bb791.svg","alt":"epc successful inbound payshap"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"proxy-resolution"},"children":["Proxy Resolution"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The proxy resolution phase aims to determine that the proxy identifier is valid and returns the details of the associated customer record in your system. The end-user that initiated the payment from their banking app can then confirm the details before initiating a credit transfer to the proxy."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum sends you an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundSynchronousIdentifierDetermination"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/identifier-determination/inboundsynchronousidentifierdetermination"},"children":["request"]}," via the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/identifiers/inbound/identifier-determination-sync"]}," endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentifierDeterminationRequest"]}," schema; below)."]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["IdentifierDeterminationRequest Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/IdentifierDeterminationRequest"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/IdentifierDeterminationRequest"},"MessageIdentifiers":{"description":"Holds a point-to-point unique message identification string as well as a message's creation date time.\n","properties":{"creationDateTime":{"description":"The date and time at which the message was created, in senders local timezone or UTC.\nThe date *must* be formatted as defined by `date-time` in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\n","format":"date-time","type":"string"},"messageIdentification":{"description":"A reference used to unambiguously identify the message between the sending and receiving party.\nTake note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.\n","maxLength":35,"type":"string"}},"required":["messageIdentification","creationDateTime"],"type":"object"},"SupplementaryData":{"additionalProperties":{"type":"string"},"description":"A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.\n","type":"object"},"BaseMessage":{"description":"A model containing the foundational elements shared across messages and generally expected in a message used\nduring processing with the Electrum Regulated Payments API.\n","properties":{"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"supplementaryData":{"$ref":"#/components/schemas/SupplementaryData"}},"required":["messageIdentifiers"],"type":"object"},"DeterminationRequest":{"description":"A request providing information for the lookup of a proxy or account in the context of the ZA RPP Payment Scheme:\n1. If the identifier schema is either MOBILE or CUSTOM, proxy resolution will be performed. In this case, the\n   `identifier.namespace` field is required.\n2. If the identifier schema is GENERIC, account resolution will be performed. In this case, the \n  `accountAgent.bicfi` field is required.\n","discriminator":{"mapping":{"ZA_RPP":"#/components/schemas/ZaRppDeterminationRequest"},"propertyName":"schema"},"properties":{"schema":{"$ref":"#/components/schemas/PaymentSchemeName"}},"required":["schema"],"type":"object"},"CustomIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"maxLength":2048,"minLength":1,"type":"string"}},"required":["value"],"type":"object"}]},"NonBankingIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"properties":{"namespace":{"description":"An identifier's namespace provides a context for the identifier to distinguish different identifiers which\nmay have the same value but be intended to identify different accounts. For example, a bank may use the same\nMSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.\n\nThis may be used by the following schemes:\n  - ZA_RPP\n","maxLength":40,"minLength":1,"type":"string"},"schema":{"description":"Indicates the schema of the identifier, e.g. `MOBILE`, `CUSTOM`.","type":"string"}},"required":["schema"],"type":"object"},"PhoneNumber":{"pattern":"^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$","type":"string"},"MobileNumberIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}},"required":["value"],"type":"object"}]},"FinancialInstitutionIdentifier":{"properties":{"bicfi":{"description":"A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as\ndescribed in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)\n","pattern":"^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$","type":"string"},"memberId":{"description":"Identification of a member of a clearing system.","maxLength":35,"type":"string"},"namespaces":{"items":{"description":"An identifier's namespace provides a context for the identifier to distinguish different identifiers which\nmay have the same value but be intended to identify different accounts. For example, a bank may use the same\nMSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.\n\nThis may be used by the following schemes:\n  - ZA_RPP\n","maxLength":40,"minLength":1,"type":"string"},"type":"array"},"schema":{"description":"Indicates the account identifier is a Financial Institution Identifier, always `FII`","type":"string"}},"required":["schema"],"type":"object"},"ExternalAccountIdentificationCode":{"description":"* `AIIN`: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).\n* `BBAN`: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.\n* `CUID`: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.\n* `UPIC`: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.\n","enum":["AIIN","BBAN","CUID","UPIC"],"type":"string"},"GenericAccountIdentificationSchemeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalAccountIdentificationCode"}},"required":["value","schema"],"type":"object"},"ProprietaryValueLiteral":{"description":"A proprietary value.","maxLength":35,"type":"string"},"ProprietaryValue":{"description":"A model that describes a proprietary value assigned by some party, the purpose of which is to provide for the\npossibility of parties using values that are not standardised.\n","properties":{"schema":{"description":"Identifies the value as being proprietary (i.e. not published in an external list). Always `PROPRIETARY`\n","type":"string"},"value":{"$ref":"#/components/schemas/ProprietaryValueLiteral"}},"required":["value","schema"],"type":"object"},"GenericAccountIdentificationScheme":{"description":"Identifies the scheme that defines the identification of a generic account.","discriminator":{"mapping":{"CODE":"#/components/schemas/GenericAccountIdentificationSchemeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/GenericAccountIdentificationSchemeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"GenericAccountIdentifier":{"properties":{"issuer":{"description":"The entity that assigns the identification","maxLength":35,"type":"string"},"schema":{"description":"Identifies this account identifier as generic, always `GENERIC`","type":"string"},"scheme":{"$ref":"#/components/schemas/GenericAccountIdentificationScheme"},"value":{"maxLength":40,"minLength":1,"type":"string"}},"required":["schema","value"],"type":"object"},"IBAN":{"description":"An identifier used internationally by financial institutions to uniquely identify the account of a customer at\na financial institution, as described in the latest edition of the international standard ISO 13616: 2007\n","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"IBANIdentifier":{"properties":{"schema":{"description":"Indicates the account identifier is an IBAN, always `IBAN`","type":"string"},"value":{"$ref":"#/components/schemas/IBAN"}},"required":["schema","value"],"type":"object"},"AccountIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","FII":"#/components/schemas/FinancialInstitutionIdentifier","GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"},{"$ref":"#/components/schemas/MobileNumberIdentifier"},{"$ref":"#/components/schemas/CustomIdentifier"},{"$ref":"#/components/schemas/FinancialInstitutionIdentifier"}],"type":"object"},"PaymentSchemeName":{"description":"Identifies the scheme used for the payment\n* `ZA_RTC`: South African Realtime Clearing scheme.\n* `ZA_RPP`: South African Realtime Payments Platform scheme.\n* `ZA_EFT`: South African Electronic Funds Transfer scheme.\n* `ZA_AC` : South African Authenticated Collections scheme.\n* `ZA_RMS`: South African Registered Mandate Service scheme.\n* `CBPR_PLUS`: Cross-Border Payments and Reporting Plus.\n","enum":["ZA_RTC","ZA_RPP","ZA_EFT","ZA_AC","ZA_RMS","CBPR_PLUS"],"type":"string"},"AccountIdentification":{"description":"Holds details pertaining to an identifier of an account or store of value.","properties":{"accountKnownAs":{"description":"A name or label of the account.","maxLength":40,"type":"string"},"identifier":{"$ref":"#/components/schemas/AccountIdentifier"},"registeredSchemes":{"description":"The list of schemes with which the identifier is registered.","items":{"$ref":"#/components/schemas/PaymentSchemeName"},"type":"array"}},"required":["identifier"],"type":"object"},"AddressTypeCode":{"description":"* `ADDR`: A postal address.\n* `PBOX`: A postal office (PO) box address.\n* `HOME`: A (residential) home address.\n* `BIZZ`: A business address.\n* `MLTO`: Address to which mail is sent.\n* `DLVY`: Address to which delivery is to take place\n","enum":["ADDR","PBOX","HOME","BIZZ","MLTO","DLVY"],"type":"string"},"CountryCode":{"description":"A code to identify a country, a dependency, or another area of particular geopolitical interest,\non the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n","pattern":"[A-Z]{2,2}","type":"string"},"PostalAddress":{"properties":{"addressLine":{"items":{"maxLength":70,"minLength":1,"type":"string"},"maxItems":7,"minItems":0,"type":"array"},"addressType":{"$ref":"#/components/schemas/AddressTypeCode"},"buildingName":{"maxLength":35,"minLength":1,"type":"string"},"buildingNumber":{"maxLength":16,"minLength":1,"type":"string"},"country":{"$ref":"#/components/schemas/CountryCode"},"countrySubDivision":{"maxLength":35,"minLength":1,"type":"string"},"department":{"maxLength":70,"minLength":1,"type":"string"},"districtName":{"maxLength":35,"minLength":1,"type":"string"},"floor":{"maxLength":70,"minLength":1,"type":"string"},"postBox":{"maxLength":16,"minLength":1,"type":"string"},"postCode":{"maxLength":16,"minLength":1,"type":"string"},"room":{"maxLength":70,"minLength":1,"type":"string"},"streetName":{"maxLength":70,"minLength":1,"type":"string"},"subDepartment":{"maxLength":70,"minLength":1,"type":"string"},"townLocationName":{"maxLength":35,"minLength":1,"type":"string"},"townName":{"maxLength":35,"minLength":1,"type":"string"}},"type":"object"},"BranchIdentification":{"properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"identification":{"description":"Unique and unambiguous identification of a branch of a financial institution.","type":"string"},"name":{"description":"The name by which this branch is known and is usually used to identify the branch.","maxLength":140,"type":"string"}},"required":["identification"],"type":"object"},"ExternalClearingSystemIdentification1Code":{"description":"* `MA` (MoroccoClearingSystemID): Clearing System ID used in Morocco\n* `ATBLZ` (AustrianBankleitzahl): Bank Branch code used in Austria.\n* `AUBSB` (AustralianBankStateBranchCodeBSB): Bank Branch code used in Australia.\n* `CACPA` (CanadianPaymentsAssociationPaymentRoutingNumber): Bank Branch code used in Canada.\n* `CHBCC` (SwissFinancialInstitutionIdentificationShort): Financial Institution Identification (IID) used in Switzerland, without check digit.\n* `CHSIC` (SwissFinancialInstitutionIdentificationLong): Financial Institution Identification (IID) used in Switzerland, including check digit.\n* `CNAPS` (CNAPSIdentifier): Bank Branch code used in China.\n* `DEBLZ` (GermanBankleitzahl): Bank Branch code used in Germany.\n* `ESNCC` (SpanishDomesticInterbankingCode): Bank Branch code used in Spain.\n* `GBDSC` (UKDomesticSortCode): Bank Branch code used in the UK.\n* `GRBIC` (HelenicBankIdentificationCode): Bank Branch code used in Greece.\n* `HKNCC` (HongKongBankCode): Bank Branch code used in Hong Kong.\n* `IENCC` (IrishNationalClearingCode): Bank Branch code used in Ireland.\n* `INFSC` (IndianFinancialSystemCode): Bank Branch code used in India.\n* `ITNCC` (ItalianDomesticIdentificationCode): Bank Branch code used in Italy.\n* `JPZGN` (JapanZenginClearingCode): Bank Branch code used in Japan.\n* `NZNCC` (NewZealandNationalClearingCode): Bank Branch code used in New Zealand.\n* `PLKNR` (PolishNationalClearingCode): Bank Branch code used in Poland.\n* `PTNCC` (PortugueseNationalClearingCode): Bank Branch code used in Portugal.\n* `RUCBC` (RussianCentralBankIdentificationCode): Bank Branch code used in Russia.\n* `SESBA` (SwedenBankgiroClearingCode): Bank Branch code used in Sweden.\n* `SGIBG` (IBGSortCode): Bank Branch code used in Singapore.\n* `THCBC` (ThaiCentralBankIdentificationCode): Bank Identification code used in Thailand.\n* `TWNCC` (FinancialInstitutionCode): Bank Branch code used in Taiwan.\n* `USABA` (UnitedStatesRoutingNumberFedwireNACHA): Routing Transit number assigned by the ABA for US financial institutions.\n* `USPID` (CHIPSParticipantIdentifier): Bank identifier used by CHIPs in the US.\n* `ZANCC` (SouthAfricanNationalClearingCode): Bank Branch code used in South Africa.\n* `NZRSA` (NewZealandRTGSClearingCode): RTGS settlement account used in New Zealand.\n* `MZBMO` (BancoDeMocambiqueRTGS): Banco de Mocambique RTGS system.\n* `CNCIP` (CrossBorderInterbankPaymentSystem): Chinese Cross-border Interbank Payment System (CIPS) Identifier.\n* `KRBOK` (SouthKoreaCentralBankIdentificationCode): Participant Institution code used by BOK-Wire+ in South Korea.\n* `BRISP` (BrazilianBankIdentificationCode): Bank Identification code used in Brazil (ISPB).\n* `NACSC` (NamibiaClearingSystemCode): Clearing system Identification code used in Namibia.\n* `ZWTSS` (ZimbabweClearingSystemCode): System Identification Code used in the Zimbabwe settlement system.\n* `AD` (AndorraClearingSystemID): Clearing System ID used in Andorra\n* `EGNCC` (EgyptianNationalClearingCode): RTGS Clearing system Identification code used in Egypt.\n* `AE` (UnitedArabEmiratesClearingSystemID): Clearing System ID used in United Arab Emirates\n* `AF` (AfghanistanClearingSystemID): Clearing System ID used in Afghanistan\n* `AI` (AntiguaandBermudaClearingSystemID): Clearing System ID used in Antigua and Bermuda\n* `AL` (AlbaniaClearingSystemID): Clearing System ID used in Albania\n* `AM` (ArmeniaClearingSystemID): Clearing System ID used in Armenia\n* `AO` (AngolaClearingSystemID): Clearing System ID used in Angola\n* `AR` (ArgentinaClearingSystemID): Clearing System ID used in Argentina\n* `AS` (AmericanSamoaClearingSystemID): Clearing System ID used in American Samoa\n* `AW` (ArubaClearingSystemID): Clearing System ID used in Aruba\n* `AZ` (AzerbaijanClearingSystemID): Clearing System ID used in Azerbaijan\n* `BA` (BosniaandHerzegovinaClearingSystemID): Clearing System ID used in Bosnia and Herzegovina\n* `BD` (BangladeshClearingSystemID): Clearing System ID used in Bangladesh\n* `BG` (BulgariaClearingSystemID): Clearing System ID used in Bulgaria\n* `BH` (BahrainClearingSystemID): Clearing System ID used in Bahrain\n* `BI` (BurundiClearingSystemID): Clearing System ID used in Burundi\n* `BL` (SaintBarthelemyClearingSystemID): Clearing System ID used in Saint Barthelemy\n* `BM` (BermudaClearingSystemID): Clearing System ID used in Bermuda\n* `BN` (BruneiDarussalamClearingSystemID): Clearing System ID used in Brunei Darussalam\n* `BO` (BoliviaClearingSystemID): Clearing System ID used in Bolivia\n* `BS` (BahamasClearingSystemID): Clearing System ID used in Bahamas\n* `BT` (BhutanClearingSystemID): Clearing System ID used in Bhutan\n* `BW` (BotswanaClearingSystemID): Clearing System ID used in Botswana\n* `BY` (BelarusClearingSystemID): Clearing System ID used in Belarus\n* `BZ` (BelizeClearingSystemID): Clearing System ID used in Belize\n* `CD` (DemocraticRepublicofTheCongoClearingSystemID): Clearing System ID used in Democratic Republic of The Congo\n* `CL` (ChileClearingSystemID): Clearing System ID used in Chile\n* `CO` (ColombiaClearingSystemID): Clearing System ID used in Colombia\n* `CR` (CostaRicaClearingSystemID): Clearing System ID used in Costa Rica\n* `CV` (CaboVerdeClearingSystemID): Clearing System ID used in Cabo Verde\n* `CW` (CuracaoClearingSystemID): Clearing System ID used in Curacao\n* `CY` (CyprusClearingSystemID): Clearing System ID used in Cyprus\n* `CZ` (CzechRepublicClearingSystemID): Clearing System ID used in Czech Republic\n* `DO` (DominicanRepublicClearingSystemID): Clearing System ID used in Dominican Republic\n* `DZ` (AlgeriaClearingSystemID): Clearing System ID used in Algeria\n* `EC` (EcuadorClearingSystemID): Clearing System ID used in Ecuador\n* `EE` (EstoniaClearingSystemID): Clearing System ID used in Estonia\n* `GE` (GeorgiaClearingSystemID): Clearing System ID used in Georgia\n* `GH` (GhanaClearingSystemID): Clearing System ID used in Ghana\n* `GN` (GuineaClearingSystemID): Clearing System ID used in Guinea\n* `GT` (GuatemalaClearingSystemID): Clearing System ID used in Guatemala\n* `GY` (GuyanaClearingSystemID): Clearing System ID used in Guyana\n* `HN` (HondurasClearingSystemID): Clearing System ID used in Honduras\n* `HR` (CroatiaClearingSystemID): Clearing System ID used in Croatia\n* `HT` (HaitiClearingSystemID): Clearing System ID used in Haiti\n* `HU` (HungaryClearingSystemID): Clearing System ID used in Hungary\n* `ID` (IndonesiaClearingSystemID): Clearing System ID used in Indonesia\n* `IL` (IsraelClearingSystemID): Clearing System ID used in Israel\n* `IQ` (IraqClearingSystemID): Clearing System ID used in Iraq\n* `IS` (IcelandClearingSystemID): Clearing System ID used in Iceland\n* `JM` (JamaicaClearingSystemID): Clearing System ID used in Jamaica\n* `JO` (JordanClearingSystemID): Clearing System ID used in Jordan\n* `KE` (KenyaClearingSystemID): Clearing System ID used in Kenya\n* `KG` (TheKyrgyzRepublicClearingSystemID): Clearing System ID used in The Kyrgyz Republic\n* `KH` (CambodiaClearingSystemID): Clearing System ID used in Cambodia\n* `KM` (ComorosClearingSystemID): Clearing System ID used in Comoros\n* `KW` (KuwaitClearingSystemID): Clearing System ID used in Kuwait\n* `KZ` (KazakhstanClearingSystemID): Clearing System ID used in Kazakhstan\n* `LB` (LebanonClearingSystemID): Clearing System ID used in Lebanon\n* `LK` (SriLankaClearingSystemID): Clearing System ID used in Sri Lanka\n* `LR` (LiberiaClearingSystemID): Clearing System ID used in Liberia\n* `LS` (LesothoClearingSystemID): Clearing System ID used in Lesotho\n* `LT` (LithuaniaClearingSystemID): Clearing System ID used in Lithuania\n* `LV` (LatviaClearingSystemID): Clearing System ID used in Latvia\n* `LY` (LibyaClearingSystemID): Clearing System ID used in Libya\n* `MD` (MoldovaClearingSystemID): Clearing System ID used in Moldova\n* `ME` (MontenegroClearingSystemID): Clearing System ID used in Montenegro\n* `MG` (MadagascarClearingSystemID): Clearing System ID used in Madagascar\n* `MK` (NorthMacedoniaClearingSystemID): Clearing System ID used in North Macedonia\n* `MN` (MongoliaClearingSystemID): Clearing System ID used in Mongolia\n* `MO` (MacaoClearingSystemID): Clearing System ID used in Macao\n* `MR` (MauritaniaClearingSystemID): Clearing System ID used in Mauritania\n* `MT` (MaltaClearingSystemID): Clearing System ID used in Malta\n* `MU` (MauritiusClearingSystemID): Clearing System ID used in Mauritius\n* `MW` (MalawiClearingSystemID): Clearing System ID used in Malawi\n* `MX` (MexicoClearingSystemID): Clearing System ID used in Mexico\n* `MY` (MalaysiaClearingSystemID): Clearing System ID used in Malaysia\n* `NG` (NigeriaClearingSystemID): Clearing System ID used in Nigeria\n* `NI` (NicaraguaClearingSystemID): Clearing System ID used in Nicaragua\n* `NP` (NepalClearingSystemID): Clearing System ID used in Nepal\n* `OM` (OmanClearingSystemID): Clearing System ID used in Oman\n* `PA` (PanamaClearingSystemID): Clearing System ID used in Panama\n* `PE` (PeruClearingSystemID): Clearing System ID used in Peru\n* `PG` (PapuaNewGuineaClearingSystemID): Clearing System ID used in Papua New Guinea\n* `PH` (PhilippinesClearingSystemID): Clearing System ID used in Philippines\n* `PK` (PakistanClearingSystemID): Clearing System ID used in Pakistan\n* `PS` (PalestineClearingSystemID): Clearing System ID used in Palestine\n* `PY` (ParaguayClearingSystemID): Clearing System ID used in Paraguay\n* `QA` (QatarClearingSystemID): Clearing System ID used in Qatar\n* `RO` (RomaniaClearingSystemID): Clearing System ID used in Romania\n* `RS` (SerbiaClearingSystemID): Clearing System ID used in Serbia\n* `RW` (RwandaClearingSystemID): Clearing System ID used in Rwanda\n* `SA` (SaudiArabiaClearingSystemID): Clearing System ID used in Saudi Arabia\n* `SC` (SeychellesClearingSystemID): Clearing System ID used in Seychelles\n* `SD` (SudanClearingSystemID): Clearing System ID used in Sudan\n* `SI` (SloveniaClearingSystemID): Clearing System ID used in Slovenia\n* `SK` (SlovakiaClearingSystemID): Clearing System ID used in Slovakia\n* `SL` (SierraLeoneClearingSystemID): Clearing System ID used in Sierra Leone\n* `ST` (SaoTomeandPrincipeClearingSystemID): Clearing System ID used in Sao Tome and Principe\n* `SV` (ElSalvadorClearingSystemID): Clearing System ID used in El Salvador\n* `SZ` (EswatiniClearingSystemID): Clearing System ID used in Eswatini\n* `TJ` (TajikistanClearingSystemID): Clearing System ID used in Tajikistan\n* `TL` (Timor): LesteClearingSystemID\tClearing System ID used in Timor-Leste\n* `TM` (TurkmenistanClearingSystemID): Clearing System ID used in Turkmenistan\n* `TN` (TunisiaClearingSystemID): Clearing System ID used in Tunisia\n* `TR` (TurkeyClearingSystemID): Clearing System ID used in Turkey\n* `TT` (TrinidadandTobagoClearingSystemID): Clearing System ID used in Trinidad and Tobago\n* `TZ` (TanzaniaClearingSystemID): Clearing System ID used in Tanzania\n* `UA` (UkraineClearingSystemID): Clearing System ID used in Ukraine\n* `UG` (UgandaClearingSystemID): Clearing System ID used in Uganda\n* `UY` (UruguayClearingSystemID): Clearing System ID used in Uruguay\n* `UZ` (UzbekistanClearingSystemID): Clearing System ID used in Uzbekistan\n* `VA` (VaticanCityClearingSystemID): Clearing System ID used in Vatican City\n* `VE` (VenezuelaClearingSystemID): Clearing System ID used in Venezuela\n* `VN` (VietnamClearingSystemID): Clearing System ID used in Vietnam\n* `XK` (KosovoClearingSystemID): Clearing System ID used in Kosovo\n* `ZM` (ZambiaClearingSystemID): Clearing System ID used in Zambia\n* `MARPA` (MoroccoRTGSParticipantIdentificationCode): RTGS participant identification code used in the Kingdom of Morocco.\n* `MARAC` (MoroccoRTGSNationalClearingCode): RTGS clearing system identification used in the Kingdom of Morocco.\n","enum":["MA","ATBLZ","AUBSB","CACPA","CHBCC","CHSIC","CNAPS","DEBLZ","ESNCC","GBDSC","GRBIC","HKNCC","IENCC","INFSC","ITNCC","JPZGN","NZNCC","PLKNR","PTNCC","RUCBC","SESBA","SGIBG","THCBC","TWNCC","USABA","USPID","ZANCC","NZRSA","MZBMO","CNCIP","KRBOK","BRISP","NACSC","ZWTSS","AD","EGNCC","AE","AF","AI","AL","AM","AO","AR","AS","AW","AZ","BA","BD","BG","BH","BI","BL","BM","BN","BO","BS","BT","BW","BY","BZ","CD","CL","CO","CR","CV","CW","CY","CZ","DO","DZ","EC","EE","GE","GH","GN","GT","GY","HN","HR","HT","HU","ID","IL","IQ","IS","JM","JO","KE","KG","KH","KM","KW","KZ","LB","LK","LR","LS","LT","LV","LY","MD","ME","MG","MK","MN","MO","MR","MT","MU","MW","MX","MY","NG","NI","NP","OM","PA","PE","PG","PH","PK","PS","PY","QA","RO","RS","RW","SA","SC","SD","SI","SK","SL","ST","SV","SZ","TJ","TL","TM","TN","TR","TT","TZ","UA","UG","UY","UZ","VA","VE","VN","XK","ZM","MARPA","MARAC"],"type":"string"},"ClearingSystemCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalClearingSystemIdentification1Code"}},"required":["schema","value"],"type":"object"},"ClearingSystemIdentification":{"discriminator":{"mapping":{"CODE":"#/components/schemas/ClearingSystemCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/ClearingSystemCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"ClearingSystemMemberIdentification":{"properties":{"clearingSystem":{"$ref":"#/components/schemas/ClearingSystemIdentification"},"memberId":{"description":"Identification of a member of a clearing system.","maxLength":35,"type":"string"}},"required":["memberId"],"type":"object"},"InstitutionIdentification":{"properties":{"additionalIdentifications":{"items":{"$ref":"#/components/schemas/AccountIdentification"},"type":"array"},"address":{"$ref":"#/components/schemas/PostalAddress"},"bicfi":{"description":"A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as\ndescribed in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)\n","pattern":"^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$","type":"string"},"branch":{"$ref":"#/components/schemas/BranchIdentification"},"clearingSystemMemberId":{"$ref":"#/components/schemas/ClearingSystemMemberIdentification"},"companyRegistration":{"deprecated":true,"description":"A unique identifier assigned to a company or organisation by a duly appointed authority within a country.","maxLength":35,"type":"string"},"lei":{"description":"An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"memberId":{"deprecated":true,"description":"Deprecated. Please use the preferred `clearingSystemMemberId.memberId` instead.\nIdentification of a member of a clearing system.\n","maxLength":35,"type":"string"},"name":{"description":"Name by which an institution is known and which is usually used to identify that institution","maxLength":140,"type":"string"}},"type":"object"},"ZaRppIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","GENERIC":"#/components/schemas/GenericAccountIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/MobileNumberIdentifier"},{"$ref":"#/components/schemas/CustomIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"}]},"ZaRppRequestor":{"discriminator":{"mapping":{"INSTITUTION_IDENTIFICATION":"#/components/schemas/InstitutionIdentificationWithSchemaAndDomain","PARTY":"#/components/schemas/PartyWithSchema"},"propertyName":"schema"},"properties":{"schema":{"type":"string"}},"type":"object"},"InstitutionIdentificationWithSchemaAndDomain":{"allOf":[{"$ref":"#/components/schemas/ZaRppRequestor"},{"$ref":"#/components/schemas/InstitutionIdentification"},{"properties":{"domain":{"description":"A BankservAfrica-specific field requirement that associates this institution with a specific \"domain\"\n- which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on\nNon-Banking Identifiers, such as a MobileIdentifier\n","maxLength":35,"type":"string"}},"type":"object"}]},"ContactDetails":{"properties":{"emailAddress":{"format":"email","type":"string"},"mobileNumber":{"$ref":"#/components/schemas/PhoneNumber"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}},"type":"object"},"OrganisationIdentifierBic":{"description":"An organisation identified by a code allocated to a financial or non-financial institution by the ISO 9362\nRegistration Authority, as described in ISO 9362: 2014 - Banking - Banking telecommunication messages -\nBusiness identifier code (BIC).\n","properties":{"BIC":{"pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}","type":"string"},"schema":{"description":"Indicates the identifier as a BIC organisation identifier, always `BIC`","type":"string"}},"required":["BIC","schema"],"type":"object"},"OrganisationIdentifierLei":{"description":"An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services -\nLegal Entity Identifier (LEI).\n","properties":{"LEI":{"pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"schema":{"description":"Indicates the identifier as a LEI organisation identifier, always `LEI`","type":"string"}},"required":["LEI","schema"],"type":"object"},"OrganisationIdentificationCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `BANK` : BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.\n* `CBID` : CentralBankIdentificationNumber. A unique identification number assigned by a central bank to identify an organisation.\n* `CHID` : ClearingIdentificationNumber. A unique identification number assigned by a clearing house to identify an organisation\n* `CINC` : CertificateOfIncorporationNumber. A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.\n* `COID` : CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)\n* `CUST` : CustomerNumber. Number assigned by an issuer to identify a customer or number assigned by a party to identify a creditor or debtor relationship.\n* `DUNS` : DataUniversalNumberingSystem. A unique identification number provided by Dun & Bradstreet to identify an organisation.\n* `EMPL` : EmployerIdentificationNumber. Number assigned by a registration authority to an employer.\n* `GS1G` : GS1GLNIdentifier. Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.\n* `SREN` : SIREN. The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n* `SRET` : SIRET. The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity\n* `TXID` : TaxIdentificationNumber. Number assigned by a tax authority to identify an organisation.\n* `BDID` : BusinessDomainIdentifier. Identifier of the business domain in which the organisation is active.\n* `BOID` : BusinessOtherIdentification. Other identification of the organisation.\n","enum":["BANK","CBID","CHID","CINC","COID","CUST","DUNS","EMPL","GS1G","SREN","SRET","TXID","BDID","BOID"],"type":"string"}},"required":["value","schema"],"type":"object"},"OrganisationIdentifierScheme":{"discriminator":{"mapping":{"CODE":"#/components/schemas/OrganisationIdentificationCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/OrganisationIdentificationCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"OrganisationIdentifierOther":{"description":"A unique identification of an organisation, as assigned by an institution, using an identification scheme.\n","properties":{"identification":{"maxLength":35,"type":"string"},"issuer":{"description":"The name of the entity that assigns the identification","maxLength":35,"type":"string"},"schema":{"description":"Indicates the identifier as a unique identification of an organisation, as assigned by an institution. Always `OTHER`","type":"string"},"scheme":{"$ref":"#/components/schemas/OrganisationIdentifierScheme"}},"required":["identification","schema"],"type":"object"},"OrganisationIdentifier":{"description":"Holds identification details for an organisation.","discriminator":{"mapping":{"BIC":"#/components/schemas/OrganisationIdentifierBic","LEI":"#/components/schemas/OrganisationIdentifierLei","OTHER":"#/components/schemas/OrganisationIdentifierOther"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/OrganisationIdentifierBic"},{"$ref":"#/components/schemas/OrganisationIdentifierLei"},{"$ref":"#/components/schemas/OrganisationIdentifierOther"}],"type":"object"},"OrganisationIdentification":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/OrganisationIdentifier"},"type":"array"},"schema":{"description":"Identifies the party as an organisation, always `ORGANISATION`","type":"string"}},"required":["identifiers","schema"],"type":"object"},"PersonIdentificationCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `ARNU`: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.\n* `CCPT`: PassportNumber. A number assigned by an authority to identify the passport number of a person.\n* `CUST`: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.\n* `DRLC`: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.\n* `EMPL`: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.\n* `NIDN`: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.\n* `SOSE`: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.\n* `TELE`: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.\n* `TXID`: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.\n* `POID`: PersonOtherIdentification. Other identification of the person.\n","enum":["ARNU","CCPT","CUST","DRLC","EMPL","NIDN","SOSE","TELE","TXID","POID"],"type":"string"}},"required":["value","schema"],"type":"object"},"PersonIdentifierScheme":{"discriminator":{"mapping":{"CODE":"#/components/schemas/PersonIdentificationCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PersonIdentificationCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"PersonIdentifier":{"properties":{"identification":{"description":"Unique and unambiguous identification of a person, for example a passport.\n","maxLength":35,"type":"string"},"issuer":{"description":"The entity that assigns the identification","maxLength":35,"type":"string"},"scheme":{"$ref":"#/components/schemas/PersonIdentifierScheme"}},"required":["identification"],"type":"object"},"PersonIdentification":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/PersonIdentifier"},"type":"array"},"schema":{"description":"Identifies the party as a person, always `PERSON`\n","type":"string"}},"required":["identifiers","schema"],"type":"object"},"PartyIdentification":{"description":"The identification of a party, either a person or an organisation.\n","discriminator":{"mapping":{"ORGANISATION":"#/components/schemas/OrganisationIdentification","PERSON":"#/components/schemas/PersonIdentification"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PersonIdentification"},{"$ref":"#/components/schemas/OrganisationIdentification"}],"type":"object"},"Party":{"description":"This model is the basic representation of a Party. It is expanded on depending on whether the party is a person\nor an organisation.\n","properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"contactDetails":{"$ref":"#/components/schemas/ContactDetails"},"countryOfResidence":{"$ref":"#/components/schemas/CountryCode"},"identification":{"$ref":"#/components/schemas/PartyIdentification"},"knownAsName":{"description":"The name by which this party is commonly known in day to day use. For example, a shortening of their legal\nname or a nickname that they commonly use. This is \"non-official\". However, it is acceptable for this field\nto be set to the same as `legalName`.\n","maxLength":140,"minLength":1,"type":"string"},"legalName":{"description":"The legal name by which this party is known (the \"FICA\" name). This is the full name of the party\nas found on country-issued documentation (national identity, company registration documentation etc).\n","maxLength":140,"minLength":1,"type":"string"}},"type":"object"},"PartyWithSchema":{"allOf":[{"$ref":"#/components/schemas/ZaRppRequestor"},{"$ref":"#/components/schemas/Party"}]},"ZaRppDeterminationRequest":{"allOf":[{"$ref":"#/components/schemas/DeterminationRequest"},{"properties":{"accountAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"identifier":{"$ref":"#/components/schemas/ZaRppIdentifier"},"instructedAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"instructingAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"requestor":{"$ref":"#/components/schemas/ZaRppRequestor"},"uetr":{"description":"Universally unique identifier to provide an end-to-end reference.\nThis identifier remains the same for all messages related to the same transaction.\n","format":"UUID","type":"string"},"verificationIdentification":{"description":"Unique identifier for this specific verification request.\n","maxLength":35,"minLength":1,"type":"string"}},"required":["identifier","uetr","verificationIdentification"],"type":"object"}]},"IdentifierDeterminationRequest":{"allOf":[{"$ref":"#/components/schemas/BaseMessage"},{"properties":{"request":{"$ref":"#/components/schemas/DeterminationRequest"},"schema":{"enum":["IdentifierDeterminationRequest"],"type":"string"}},"required":["request","schema"],"type":"object"}],"type":"object"}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-openapi/epc-cicd/epc-elpapi-partner-redoc.yaml","operationId":"inboundSynchronousIdentifierDetermination","exampleKey":"ZA-RPP-Proxy-Resolution-Request","language":"Payload","parameters":{},"options":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You identify the customer proxy and verify the related customer record."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You return an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentifierDeterminationResponse"]}," to Electrum (see schema below)."]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"IMPORTANT"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are a number of fields in the response message that MUST be populated, even if they are designated as optional in the API. See the table below for a list of these fields and guidelines on how to populate them."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Guidelines for Populating Field"},"children":["Guidelines for Populating Field"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.accountInformation.creationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date on which the account referenced by this proxy identifier was created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.accountInformation.proxy.value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The proxy value. This consists of a string of up to 2048 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.accountInformation.proxy.schema"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The schema of the identifier.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the case of a mobile proxy that the customer has linked to their customer record, the schema is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MOBILE"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the case of a custom proxy where a proxy is automatically assigned by the corporate client, the schema is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM"]},"."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.accountOwner.knownAsName"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This field is included so that it can be verified by the end-user using their banking app."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the case of a mobile proxy that the customer has linked to their customer record, the customer should have been prompted to select a 'known as name'."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the case of a custom proxy where a proxy is automatically assigned by the corporate client, the field should be populated in a way that allows customers to identify their transaction clearly."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Any combination of fields available for use in this field is acceptable."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"NOTE"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum will populate the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.accountOwner.legalName"]}," with the official entity name of the corporate client, as specified by the sponsor bank."]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["IdentifierDeterminationResponse Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/IdentifierDeterminationResponse"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/IdentifierDeterminationResponse"},"MessageIdentifiers":{"description":"Holds a point-to-point unique message identification string as well as a message's creation date time.\n","properties":{"creationDateTime":{"description":"The date and time at which the message was created, in senders local timezone or UTC.\nThe date *must* be formatted as defined by `date-time` in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\n","format":"date-time","type":"string"},"messageIdentification":{"description":"A reference used to unambiguously identify the message between the sending and receiving party.\nTake note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.\n","maxLength":35,"type":"string"}},"required":["messageIdentification","creationDateTime"],"type":"object"},"SupplementaryData":{"additionalProperties":{"type":"string"},"description":"A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.\n","type":"object"},"BaseMessage":{"description":"A model containing the foundational elements shared across messages and generally expected in a message used\nduring processing with the Electrum Regulated Payments API.\n","properties":{"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"supplementaryData":{"$ref":"#/components/schemas/SupplementaryData"}},"required":["messageIdentifiers"],"type":"object"},"BaseResponseMessage":{"allOf":[{"$ref":"#/components/schemas/BaseMessage"},{"description":"An extension of `BaseMessage` which includes additional information pertinent to an asynchronous response\nmessage. In particular, original message identifiers.\n","properties":{"originalMessageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"}},"required":["originalMessageIdentifiers"],"type":"object"}]},"IdentifierDeterminationReport":{"discriminator":{"mapping":{"ZA_RPP":"#/components/schemas/ZaRppIdentifierDeterminationReport"},"propertyName":"schema"},"properties":{"schema":{"$ref":"#/components/schemas/PaymentSchemeName"}},"required":["schema"],"type":"object"},"CustomIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"maxLength":2048,"minLength":1,"type":"string"}},"required":["value"],"type":"object"}]},"NonBankingIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"properties":{"namespace":{"description":"An identifier's namespace provides a context for the identifier to distinguish different identifiers which\nmay have the same value but be intended to identify different accounts. For example, a bank may use the same\nMSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.\n\nThis may be used by the following schemes:\n  - ZA_RPP\n","maxLength":40,"minLength":1,"type":"string"},"schema":{"description":"Indicates the schema of the identifier, e.g. `MOBILE`, `CUSTOM`.","type":"string"}},"required":["schema"],"type":"object"},"PhoneNumber":{"pattern":"^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$","type":"string"},"MobileNumberIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}},"required":["value"],"type":"object"}]},"FinancialInstitutionIdentifier":{"properties":{"bicfi":{"description":"A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as\ndescribed in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)\n","pattern":"^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$","type":"string"},"memberId":{"description":"Identification of a member of a clearing system.","maxLength":35,"type":"string"},"namespaces":{"items":{"description":"An identifier's namespace provides a context for the identifier to distinguish different identifiers which\nmay have the same value but be intended to identify different accounts. For example, a bank may use the same\nMSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.\n\nThis may be used by the following schemes:\n  - ZA_RPP\n","maxLength":40,"minLength":1,"type":"string"},"type":"array"},"schema":{"description":"Indicates the account identifier is a Financial Institution Identifier, always `FII`","type":"string"}},"required":["schema"],"type":"object"},"ExternalAccountIdentificationCode":{"description":"* `AIIN`: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).\n* `BBAN`: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.\n* `CUID`: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.\n* `UPIC`: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.\n","enum":["AIIN","BBAN","CUID","UPIC"],"type":"string"},"GenericAccountIdentificationSchemeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalAccountIdentificationCode"}},"required":["value","schema"],"type":"object"},"ProprietaryValueLiteral":{"description":"A proprietary value.","maxLength":35,"type":"string"},"ProprietaryValue":{"description":"A model that describes a proprietary value assigned by some party, the purpose of which is to provide for the\npossibility of parties using values that are not standardised.\n","properties":{"schema":{"description":"Identifies the value as being proprietary (i.e. not published in an external list). Always `PROPRIETARY`\n","type":"string"},"value":{"$ref":"#/components/schemas/ProprietaryValueLiteral"}},"required":["value","schema"],"type":"object"},"GenericAccountIdentificationScheme":{"description":"Identifies the scheme that defines the identification of a generic account.","discriminator":{"mapping":{"CODE":"#/components/schemas/GenericAccountIdentificationSchemeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/GenericAccountIdentificationSchemeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"GenericAccountIdentifier":{"properties":{"issuer":{"description":"The entity that assigns the identification","maxLength":35,"type":"string"},"schema":{"description":"Identifies this account identifier as generic, always `GENERIC`","type":"string"},"scheme":{"$ref":"#/components/schemas/GenericAccountIdentificationScheme"},"value":{"maxLength":40,"minLength":1,"type":"string"}},"required":["schema","value"],"type":"object"},"IBAN":{"description":"An identifier used internationally by financial institutions to uniquely identify the account of a customer at\na financial institution, as described in the latest edition of the international standard ISO 13616: 2007\n","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"IBANIdentifier":{"properties":{"schema":{"description":"Indicates the account identifier is an IBAN, always `IBAN`","type":"string"},"value":{"$ref":"#/components/schemas/IBAN"}},"required":["schema","value"],"type":"object"},"AccountIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","FII":"#/components/schemas/FinancialInstitutionIdentifier","GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"},{"$ref":"#/components/schemas/MobileNumberIdentifier"},{"$ref":"#/components/schemas/CustomIdentifier"},{"$ref":"#/components/schemas/FinancialInstitutionIdentifier"}],"type":"object"},"PaymentSchemeName":{"description":"Identifies the scheme used for the payment\n* `ZA_RTC`: South African Realtime Clearing scheme.\n* `ZA_RPP`: South African Realtime Payments Platform scheme.\n* `ZA_EFT`: South African Electronic Funds Transfer scheme.\n* `ZA_AC` : South African Authenticated Collections scheme.\n* `ZA_RMS`: South African Registered Mandate Service scheme.\n* `CBPR_PLUS`: Cross-Border Payments and Reporting Plus.\n","enum":["ZA_RTC","ZA_RPP","ZA_EFT","ZA_AC","ZA_RMS","CBPR_PLUS"],"type":"string"},"AccountIdentification":{"description":"Holds details pertaining to an identifier of an account or store of value.","properties":{"accountKnownAs":{"description":"A name or label of the account.","maxLength":40,"type":"string"},"identifier":{"$ref":"#/components/schemas/AccountIdentifier"},"registeredSchemes":{"description":"The list of schemes with which the identifier is registered.","items":{"$ref":"#/components/schemas/PaymentSchemeName"},"type":"array"}},"required":["identifier"],"type":"object"},"AddressTypeCode":{"description":"* `ADDR`: A postal address.\n* `PBOX`: A postal office (PO) box address.\n* `HOME`: A (residential) home address.\n* `BIZZ`: A business address.\n* `MLTO`: Address to which mail is sent.\n* `DLVY`: Address to which delivery is to take place\n","enum":["ADDR","PBOX","HOME","BIZZ","MLTO","DLVY"],"type":"string"},"CountryCode":{"description":"A code to identify a country, a dependency, or another area of particular geopolitical interest,\non the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n","pattern":"[A-Z]{2,2}","type":"string"},"PostalAddress":{"properties":{"addressLine":{"items":{"maxLength":70,"minLength":1,"type":"string"},"maxItems":7,"minItems":0,"type":"array"},"addressType":{"$ref":"#/components/schemas/AddressTypeCode"},"buildingName":{"maxLength":35,"minLength":1,"type":"string"},"buildingNumber":{"maxLength":16,"minLength":1,"type":"string"},"country":{"$ref":"#/components/schemas/CountryCode"},"countrySubDivision":{"maxLength":35,"minLength":1,"type":"string"},"department":{"maxLength":70,"minLength":1,"type":"string"},"districtName":{"maxLength":35,"minLength":1,"type":"string"},"floor":{"maxLength":70,"minLength":1,"type":"string"},"postBox":{"maxLength":16,"minLength":1,"type":"string"},"postCode":{"maxLength":16,"minLength":1,"type":"string"},"room":{"maxLength":70,"minLength":1,"type":"string"},"streetName":{"maxLength":70,"minLength":1,"type":"string"},"subDepartment":{"maxLength":70,"minLength":1,"type":"string"},"townLocationName":{"maxLength":35,"minLength":1,"type":"string"},"townName":{"maxLength":35,"minLength":1,"type":"string"}},"type":"object"},"BranchIdentification":{"properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"identification":{"description":"Unique and unambiguous identification of a branch of a financial institution.","type":"string"},"name":{"description":"The name by which this branch is known and is usually used to identify the branch.","maxLength":140,"type":"string"}},"required":["identification"],"type":"object"},"ExternalClearingSystemIdentification1Code":{"description":"* `MA` (MoroccoClearingSystemID): Clearing System ID used in Morocco\n* `ATBLZ` (AustrianBankleitzahl): Bank Branch code used in Austria.\n* `AUBSB` (AustralianBankStateBranchCodeBSB): Bank Branch code used in Australia.\n* `CACPA` (CanadianPaymentsAssociationPaymentRoutingNumber): Bank Branch code used in Canada.\n* `CHBCC` (SwissFinancialInstitutionIdentificationShort): Financial Institution Identification (IID) used in Switzerland, without check digit.\n* `CHSIC` (SwissFinancialInstitutionIdentificationLong): Financial Institution Identification (IID) used in Switzerland, including check digit.\n* `CNAPS` (CNAPSIdentifier): Bank Branch code used in China.\n* `DEBLZ` (GermanBankleitzahl): Bank Branch code used in Germany.\n* `ESNCC` (SpanishDomesticInterbankingCode): Bank Branch code used in Spain.\n* `GBDSC` (UKDomesticSortCode): Bank Branch code used in the UK.\n* `GRBIC` (HelenicBankIdentificationCode): Bank Branch code used in Greece.\n* `HKNCC` (HongKongBankCode): Bank Branch code used in Hong Kong.\n* `IENCC` (IrishNationalClearingCode): Bank Branch code used in Ireland.\n* `INFSC` (IndianFinancialSystemCode): Bank Branch code used in India.\n* `ITNCC` (ItalianDomesticIdentificationCode): Bank Branch code used in Italy.\n* `JPZGN` (JapanZenginClearingCode): Bank Branch code used in Japan.\n* `NZNCC` (NewZealandNationalClearingCode): Bank Branch code used in New Zealand.\n* `PLKNR` (PolishNationalClearingCode): Bank Branch code used in Poland.\n* `PTNCC` (PortugueseNationalClearingCode): Bank Branch code used in Portugal.\n* `RUCBC` (RussianCentralBankIdentificationCode): Bank Branch code used in Russia.\n* `SESBA` (SwedenBankgiroClearingCode): Bank Branch code used in Sweden.\n* `SGIBG` (IBGSortCode): Bank Branch code used in Singapore.\n* `THCBC` (ThaiCentralBankIdentificationCode): Bank Identification code used in Thailand.\n* `TWNCC` (FinancialInstitutionCode): Bank Branch code used in Taiwan.\n* `USABA` (UnitedStatesRoutingNumberFedwireNACHA): Routing Transit number assigned by the ABA for US financial institutions.\n* `USPID` (CHIPSParticipantIdentifier): Bank identifier used by CHIPs in the US.\n* `ZANCC` (SouthAfricanNationalClearingCode): Bank Branch code used in South Africa.\n* `NZRSA` (NewZealandRTGSClearingCode): RTGS settlement account used in New Zealand.\n* `MZBMO` (BancoDeMocambiqueRTGS): Banco de Mocambique RTGS system.\n* `CNCIP` (CrossBorderInterbankPaymentSystem): Chinese Cross-border Interbank Payment System (CIPS) Identifier.\n* `KRBOK` (SouthKoreaCentralBankIdentificationCode): Participant Institution code used by BOK-Wire+ in South Korea.\n* `BRISP` (BrazilianBankIdentificationCode): Bank Identification code used in Brazil (ISPB).\n* `NACSC` (NamibiaClearingSystemCode): Clearing system Identification code used in Namibia.\n* `ZWTSS` (ZimbabweClearingSystemCode): System Identification Code used in the Zimbabwe settlement system.\n* `AD` (AndorraClearingSystemID): Clearing System ID used in Andorra\n* `EGNCC` (EgyptianNationalClearingCode): RTGS Clearing system Identification code used in Egypt.\n* `AE` (UnitedArabEmiratesClearingSystemID): Clearing System ID used in United Arab Emirates\n* `AF` (AfghanistanClearingSystemID): Clearing System ID used in Afghanistan\n* `AI` (AntiguaandBermudaClearingSystemID): Clearing System ID used in Antigua and Bermuda\n* `AL` (AlbaniaClearingSystemID): Clearing System ID used in Albania\n* `AM` (ArmeniaClearingSystemID): Clearing System ID used in Armenia\n* `AO` (AngolaClearingSystemID): Clearing System ID used in Angola\n* `AR` (ArgentinaClearingSystemID): Clearing System ID used in Argentina\n* `AS` (AmericanSamoaClearingSystemID): Clearing System ID used in American Samoa\n* `AW` (ArubaClearingSystemID): Clearing System ID used in Aruba\n* `AZ` (AzerbaijanClearingSystemID): Clearing System ID used in Azerbaijan\n* `BA` (BosniaandHerzegovinaClearingSystemID): Clearing System ID used in Bosnia and Herzegovina\n* `BD` (BangladeshClearingSystemID): Clearing System ID used in Bangladesh\n* `BG` (BulgariaClearingSystemID): Clearing System ID used in Bulgaria\n* `BH` (BahrainClearingSystemID): Clearing System ID used in Bahrain\n* `BI` (BurundiClearingSystemID): Clearing System ID used in Burundi\n* `BL` (SaintBarthelemyClearingSystemID): Clearing System ID used in Saint Barthelemy\n* `BM` (BermudaClearingSystemID): Clearing System ID used in Bermuda\n* `BN` (BruneiDarussalamClearingSystemID): Clearing System ID used in Brunei Darussalam\n* `BO` (BoliviaClearingSystemID): Clearing System ID used in Bolivia\n* `BS` (BahamasClearingSystemID): Clearing System ID used in Bahamas\n* `BT` (BhutanClearingSystemID): Clearing System ID used in Bhutan\n* `BW` (BotswanaClearingSystemID): Clearing System ID used in Botswana\n* `BY` (BelarusClearingSystemID): Clearing System ID used in Belarus\n* `BZ` (BelizeClearingSystemID): Clearing System ID used in Belize\n* `CD` (DemocraticRepublicofTheCongoClearingSystemID): Clearing System ID used in Democratic Republic of The Congo\n* `CL` (ChileClearingSystemID): Clearing System ID used in Chile\n* `CO` (ColombiaClearingSystemID): Clearing System ID used in Colombia\n* `CR` (CostaRicaClearingSystemID): Clearing System ID used in Costa Rica\n* `CV` (CaboVerdeClearingSystemID): Clearing System ID used in Cabo Verde\n* `CW` (CuracaoClearingSystemID): Clearing System ID used in Curacao\n* `CY` (CyprusClearingSystemID): Clearing System ID used in Cyprus\n* `CZ` (CzechRepublicClearingSystemID): Clearing System ID used in Czech Republic\n* `DO` (DominicanRepublicClearingSystemID): Clearing System ID used in Dominican Republic\n* `DZ` (AlgeriaClearingSystemID): Clearing System ID used in Algeria\n* `EC` (EcuadorClearingSystemID): Clearing System ID used in Ecuador\n* `EE` (EstoniaClearingSystemID): Clearing System ID used in Estonia\n* `GE` (GeorgiaClearingSystemID): Clearing System ID used in Georgia\n* `GH` (GhanaClearingSystemID): Clearing System ID used in Ghana\n* `GN` (GuineaClearingSystemID): Clearing System ID used in Guinea\n* `GT` (GuatemalaClearingSystemID): Clearing System ID used in Guatemala\n* `GY` (GuyanaClearingSystemID): Clearing System ID used in Guyana\n* `HN` (HondurasClearingSystemID): Clearing System ID used in Honduras\n* `HR` (CroatiaClearingSystemID): Clearing System ID used in Croatia\n* `HT` (HaitiClearingSystemID): Clearing System ID used in Haiti\n* `HU` (HungaryClearingSystemID): Clearing System ID used in Hungary\n* `ID` (IndonesiaClearingSystemID): Clearing System ID used in Indonesia\n* `IL` (IsraelClearingSystemID): Clearing System ID used in Israel\n* `IQ` (IraqClearingSystemID): Clearing System ID used in Iraq\n* `IS` (IcelandClearingSystemID): Clearing System ID used in Iceland\n* `JM` (JamaicaClearingSystemID): Clearing System ID used in Jamaica\n* `JO` (JordanClearingSystemID): Clearing System ID used in Jordan\n* `KE` (KenyaClearingSystemID): Clearing System ID used in Kenya\n* `KG` (TheKyrgyzRepublicClearingSystemID): Clearing System ID used in The Kyrgyz Republic\n* `KH` (CambodiaClearingSystemID): Clearing System ID used in Cambodia\n* `KM` (ComorosClearingSystemID): Clearing System ID used in Comoros\n* `KW` (KuwaitClearingSystemID): Clearing System ID used in Kuwait\n* `KZ` (KazakhstanClearingSystemID): Clearing System ID used in Kazakhstan\n* `LB` (LebanonClearingSystemID): Clearing System ID used in Lebanon\n* `LK` (SriLankaClearingSystemID): Clearing System ID used in Sri Lanka\n* `LR` (LiberiaClearingSystemID): Clearing System ID used in Liberia\n* `LS` (LesothoClearingSystemID): Clearing System ID used in Lesotho\n* `LT` (LithuaniaClearingSystemID): Clearing System ID used in Lithuania\n* `LV` (LatviaClearingSystemID): Clearing System ID used in Latvia\n* `LY` (LibyaClearingSystemID): Clearing System ID used in Libya\n* `MD` (MoldovaClearingSystemID): Clearing System ID used in Moldova\n* `ME` (MontenegroClearingSystemID): Clearing System ID used in Montenegro\n* `MG` (MadagascarClearingSystemID): Clearing System ID used in Madagascar\n* `MK` (NorthMacedoniaClearingSystemID): Clearing System ID used in North Macedonia\n* `MN` (MongoliaClearingSystemID): Clearing System ID used in Mongolia\n* `MO` (MacaoClearingSystemID): Clearing System ID used in Macao\n* `MR` (MauritaniaClearingSystemID): Clearing System ID used in Mauritania\n* `MT` (MaltaClearingSystemID): Clearing System ID used in Malta\n* `MU` (MauritiusClearingSystemID): Clearing System ID used in Mauritius\n* `MW` (MalawiClearingSystemID): Clearing System ID used in Malawi\n* `MX` (MexicoClearingSystemID): Clearing System ID used in Mexico\n* `MY` (MalaysiaClearingSystemID): Clearing System ID used in Malaysia\n* `NG` (NigeriaClearingSystemID): Clearing System ID used in Nigeria\n* `NI` (NicaraguaClearingSystemID): Clearing System ID used in Nicaragua\n* `NP` (NepalClearingSystemID): Clearing System ID used in Nepal\n* `OM` (OmanClearingSystemID): Clearing System ID used in Oman\n* `PA` (PanamaClearingSystemID): Clearing System ID used in Panama\n* `PE` (PeruClearingSystemID): Clearing System ID used in Peru\n* `PG` (PapuaNewGuineaClearingSystemID): Clearing System ID used in Papua New Guinea\n* `PH` (PhilippinesClearingSystemID): Clearing System ID used in Philippines\n* `PK` (PakistanClearingSystemID): Clearing System ID used in Pakistan\n* `PS` (PalestineClearingSystemID): Clearing System ID used in Palestine\n* `PY` (ParaguayClearingSystemID): Clearing System ID used in Paraguay\n* `QA` (QatarClearingSystemID): Clearing System ID used in Qatar\n* `RO` (RomaniaClearingSystemID): Clearing System ID used in Romania\n* `RS` (SerbiaClearingSystemID): Clearing System ID used in Serbia\n* `RW` (RwandaClearingSystemID): Clearing System ID used in Rwanda\n* `SA` (SaudiArabiaClearingSystemID): Clearing System ID used in Saudi Arabia\n* `SC` (SeychellesClearingSystemID): Clearing System ID used in Seychelles\n* `SD` (SudanClearingSystemID): Clearing System ID used in Sudan\n* `SI` (SloveniaClearingSystemID): Clearing System ID used in Slovenia\n* `SK` (SlovakiaClearingSystemID): Clearing System ID used in Slovakia\n* `SL` (SierraLeoneClearingSystemID): Clearing System ID used in Sierra Leone\n* `ST` (SaoTomeandPrincipeClearingSystemID): Clearing System ID used in Sao Tome and Principe\n* `SV` (ElSalvadorClearingSystemID): Clearing System ID used in El Salvador\n* `SZ` (EswatiniClearingSystemID): Clearing System ID used in Eswatini\n* `TJ` (TajikistanClearingSystemID): Clearing System ID used in Tajikistan\n* `TL` (Timor): LesteClearingSystemID\tClearing System ID used in Timor-Leste\n* `TM` (TurkmenistanClearingSystemID): Clearing System ID used in Turkmenistan\n* `TN` (TunisiaClearingSystemID): Clearing System ID used in Tunisia\n* `TR` (TurkeyClearingSystemID): Clearing System ID used in Turkey\n* `TT` (TrinidadandTobagoClearingSystemID): Clearing System ID used in Trinidad and Tobago\n* `TZ` (TanzaniaClearingSystemID): Clearing System ID used in Tanzania\n* `UA` (UkraineClearingSystemID): Clearing System ID used in Ukraine\n* `UG` (UgandaClearingSystemID): Clearing System ID used in Uganda\n* `UY` (UruguayClearingSystemID): Clearing System ID used in Uruguay\n* `UZ` (UzbekistanClearingSystemID): Clearing System ID used in Uzbekistan\n* `VA` (VaticanCityClearingSystemID): Clearing System ID used in Vatican City\n* `VE` (VenezuelaClearingSystemID): Clearing System ID used in Venezuela\n* `VN` (VietnamClearingSystemID): Clearing System ID used in Vietnam\n* `XK` (KosovoClearingSystemID): Clearing System ID used in Kosovo\n* `ZM` (ZambiaClearingSystemID): Clearing System ID used in Zambia\n* `MARPA` (MoroccoRTGSParticipantIdentificationCode): RTGS participant identification code used in the Kingdom of Morocco.\n* `MARAC` (MoroccoRTGSNationalClearingCode): RTGS clearing system identification used in the Kingdom of Morocco.\n","enum":["MA","ATBLZ","AUBSB","CACPA","CHBCC","CHSIC","CNAPS","DEBLZ","ESNCC","GBDSC","GRBIC","HKNCC","IENCC","INFSC","ITNCC","JPZGN","NZNCC","PLKNR","PTNCC","RUCBC","SESBA","SGIBG","THCBC","TWNCC","USABA","USPID","ZANCC","NZRSA","MZBMO","CNCIP","KRBOK","BRISP","NACSC","ZWTSS","AD","EGNCC","AE","AF","AI","AL","AM","AO","AR","AS","AW","AZ","BA","BD","BG","BH","BI","BL","BM","BN","BO","BS","BT","BW","BY","BZ","CD","CL","CO","CR","CV","CW","CY","CZ","DO","DZ","EC","EE","GE","GH","GN","GT","GY","HN","HR","HT","HU","ID","IL","IQ","IS","JM","JO","KE","KG","KH","KM","KW","KZ","LB","LK","LR","LS","LT","LV","LY","MD","ME","MG","MK","MN","MO","MR","MT","MU","MW","MX","MY","NG","NI","NP","OM","PA","PE","PG","PH","PK","PS","PY","QA","RO","RS","RW","SA","SC","SD","SI","SK","SL","ST","SV","SZ","TJ","TL","TM","TN","TR","TT","TZ","UA","UG","UY","UZ","VA","VE","VN","XK","ZM","MARPA","MARAC"],"type":"string"},"ClearingSystemCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalClearingSystemIdentification1Code"}},"required":["schema","value"],"type":"object"},"ClearingSystemIdentification":{"discriminator":{"mapping":{"CODE":"#/components/schemas/ClearingSystemCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/ClearingSystemCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"ClearingSystemMemberIdentification":{"properties":{"clearingSystem":{"$ref":"#/components/schemas/ClearingSystemIdentification"},"memberId":{"description":"Identification of a member of a clearing system.","maxLength":35,"type":"string"}},"required":["memberId"],"type":"object"},"InstitutionIdentification":{"properties":{"additionalIdentifications":{"items":{"$ref":"#/components/schemas/AccountIdentification"},"type":"array"},"address":{"$ref":"#/components/schemas/PostalAddress"},"bicfi":{"description":"A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as\ndescribed in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)\n","pattern":"^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$","type":"string"},"branch":{"$ref":"#/components/schemas/BranchIdentification"},"clearingSystemMemberId":{"$ref":"#/components/schemas/ClearingSystemMemberIdentification"},"companyRegistration":{"deprecated":true,"description":"A unique identifier assigned to a company or organisation by a duly appointed authority within a country.","maxLength":35,"type":"string"},"lei":{"description":"An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"memberId":{"deprecated":true,"description":"Deprecated. Please use the preferred `clearingSystemMemberId.memberId` instead.\nIdentification of a member of a clearing system.\n","maxLength":35,"type":"string"},"name":{"description":"Name by which an institution is known and which is usually used to identify that institution","maxLength":140,"type":"string"}},"type":"object"},"CreditorAgentInstruction":{"description":"Further information related to the processing of the payment instruction that may need to be\nacted upon by the creditor's agent. The instruction may relate to a level of service, or may be an\ninstruction that has to be executed by the creditor's agent, or may be information required by the\ncreditor's agent\n","properties":{"code":{"description":"* `CHQB`: (PayCreditorByCheque) (Ultimate) creditor must be paid by cheque.\n* `HOLD`: (HoldCashForCreditor) Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.\n* `PHOB`: (PhoneBeneficiary) Please advise/contact (ultimate) creditor/claimant by phone.\n* `PRTK`: (PayerTokenRequested) Indicates that a payer token is requested/used.\n* `RECI`: (ReceiverCustomerInformation) Further information regarding the intended recipient.\n* `TELB`: (Telecom) Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication.\n* `TKCM`: (TokenCounterpartyMismatch) Token found with counterparty mismatch.\n* `TKSG`: (TokenSingleUse) Single Use Token already used.\n* `TKSP`: (TokenSuspended) Token found with suspended status.\n* `TKVE`: (TokenValueLimitExceeded) Token found with value limit rule violation.\n* `TKXP`: (TokenExpired) Token expired.\n* `TOKN`: (Token) Token information.\n* `VLTK`: (TokenValidation) Additional validation information to be used in conjunction with the token.\n* `SEID`: (SecondaryIdentification): Use of Secondary Identification of Creditor Account (which may relate to Head Office Collection Account, Building Society Roll Number or Credit Card Primary Account Number).\n* `RT14`: A `ZA-RPP` scheme-specific instruction regarding fraud scores.\n","enum":["CHQB","HOLD","PHOB","PRTK","RECI","TELB","TKCM","TKSG","TKSP","TKVE","TKXP","TOKN","VLTK","SEID","RT14"],"type":"string"},"information":{"description":"Further information complementing the coded instruction or instruction to the next agent that\nis bilaterally agreed or specific to a user community.\n","maxLength":140,"minLength":1,"type":"string"}},"type":"object"},"ZaRppRequestor":{"discriminator":{"mapping":{"INSTITUTION_IDENTIFICATION":"#/components/schemas/InstitutionIdentificationWithSchemaAndDomain","PARTY":"#/components/schemas/PartyWithSchema"},"propertyName":"schema"},"properties":{"schema":{"type":"string"}},"type":"object"},"InstitutionIdentificationWithSchemaAndDomain":{"allOf":[{"$ref":"#/components/schemas/ZaRppRequestor"},{"$ref":"#/components/schemas/InstitutionIdentification"},{"properties":{"domain":{"description":"A BankservAfrica-specific field requirement that associates this institution with a specific \"domain\"\n- which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on\nNon-Banking Identifiers, such as a MobileIdentifier\n","maxLength":35,"type":"string"}},"type":"object"}]},"ContactDetails":{"properties":{"emailAddress":{"format":"email","type":"string"},"mobileNumber":{"$ref":"#/components/schemas/PhoneNumber"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}},"type":"object"},"OrganisationIdentifierBic":{"description":"An organisation identified by a code allocated to a financial or non-financial institution by the ISO 9362\nRegistration Authority, as described in ISO 9362: 2014 - Banking - Banking telecommunication messages -\nBusiness identifier code (BIC).\n","properties":{"BIC":{"pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}","type":"string"},"schema":{"description":"Indicates the identifier as a BIC organisation identifier, always `BIC`","type":"string"}},"required":["BIC","schema"],"type":"object"},"OrganisationIdentifierLei":{"description":"An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services -\nLegal Entity Identifier (LEI).\n","properties":{"LEI":{"pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"schema":{"description":"Indicates the identifier as a LEI organisation identifier, always `LEI`","type":"string"}},"required":["LEI","schema"],"type":"object"},"OrganisationIdentificationCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `BANK` : BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.\n* `CBID` : CentralBankIdentificationNumber. A unique identification number assigned by a central bank to identify an organisation.\n* `CHID` : ClearingIdentificationNumber. A unique identification number assigned by a clearing house to identify an organisation\n* `CINC` : CertificateOfIncorporationNumber. A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.\n* `COID` : CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)\n* `CUST` : CustomerNumber. Number assigned by an issuer to identify a customer or number assigned by a party to identify a creditor or debtor relationship.\n* `DUNS` : DataUniversalNumberingSystem. A unique identification number provided by Dun & Bradstreet to identify an organisation.\n* `EMPL` : EmployerIdentificationNumber. Number assigned by a registration authority to an employer.\n* `GS1G` : GS1GLNIdentifier. Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.\n* `SREN` : SIREN. The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n* `SRET` : SIRET. The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity\n* `TXID` : TaxIdentificationNumber. Number assigned by a tax authority to identify an organisation.\n* `BDID` : BusinessDomainIdentifier. Identifier of the business domain in which the organisation is active.\n* `BOID` : BusinessOtherIdentification. Other identification of the organisation.\n","enum":["BANK","CBID","CHID","CINC","COID","CUST","DUNS","EMPL","GS1G","SREN","SRET","TXID","BDID","BOID"],"type":"string"}},"required":["value","schema"],"type":"object"},"OrganisationIdentifierScheme":{"discriminator":{"mapping":{"CODE":"#/components/schemas/OrganisationIdentificationCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/OrganisationIdentificationCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"OrganisationIdentifierOther":{"description":"A unique identification of an organisation, as assigned by an institution, using an identification scheme.\n","properties":{"identification":{"maxLength":35,"type":"string"},"issuer":{"description":"The name of the entity that assigns the identification","maxLength":35,"type":"string"},"schema":{"description":"Indicates the identifier as a unique identification of an organisation, as assigned by an institution. Always `OTHER`","type":"string"},"scheme":{"$ref":"#/components/schemas/OrganisationIdentifierScheme"}},"required":["identification","schema"],"type":"object"},"OrganisationIdentifier":{"description":"Holds identification details for an organisation.","discriminator":{"mapping":{"BIC":"#/components/schemas/OrganisationIdentifierBic","LEI":"#/components/schemas/OrganisationIdentifierLei","OTHER":"#/components/schemas/OrganisationIdentifierOther"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/OrganisationIdentifierBic"},{"$ref":"#/components/schemas/OrganisationIdentifierLei"},{"$ref":"#/components/schemas/OrganisationIdentifierOther"}],"type":"object"},"OrganisationIdentification":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/OrganisationIdentifier"},"type":"array"},"schema":{"description":"Identifies the party as an organisation, always `ORGANISATION`","type":"string"}},"required":["identifiers","schema"],"type":"object"},"PersonIdentificationCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `ARNU`: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.\n* `CCPT`: PassportNumber. A number assigned by an authority to identify the passport number of a person.\n* `CUST`: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.\n* `DRLC`: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.\n* `EMPL`: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.\n* `NIDN`: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.\n* `SOSE`: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.\n* `TELE`: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.\n* `TXID`: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.\n* `POID`: PersonOtherIdentification. Other identification of the person.\n","enum":["ARNU","CCPT","CUST","DRLC","EMPL","NIDN","SOSE","TELE","TXID","POID"],"type":"string"}},"required":["value","schema"],"type":"object"},"PersonIdentifierScheme":{"discriminator":{"mapping":{"CODE":"#/components/schemas/PersonIdentificationCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PersonIdentificationCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"PersonIdentifier":{"properties":{"identification":{"description":"Unique and unambiguous identification of a person, for example a passport.\n","maxLength":35,"type":"string"},"issuer":{"description":"The entity that assigns the identification","maxLength":35,"type":"string"},"scheme":{"$ref":"#/components/schemas/PersonIdentifierScheme"}},"required":["identification"],"type":"object"},"PersonIdentification":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/PersonIdentifier"},"type":"array"},"schema":{"description":"Identifies the party as a person, always `PERSON`\n","type":"string"}},"required":["identifiers","schema"],"type":"object"},"PartyIdentification":{"description":"The identification of a party, either a person or an organisation.\n","discriminator":{"mapping":{"ORGANISATION":"#/components/schemas/OrganisationIdentification","PERSON":"#/components/schemas/PersonIdentification"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PersonIdentification"},{"$ref":"#/components/schemas/OrganisationIdentification"}],"type":"object"},"Party":{"description":"This model is the basic representation of a Party. It is expanded on depending on whether the party is a person\nor an organisation.\n","properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"contactDetails":{"$ref":"#/components/schemas/ContactDetails"},"countryOfResidence":{"$ref":"#/components/schemas/CountryCode"},"identification":{"$ref":"#/components/schemas/PartyIdentification"},"knownAsName":{"description":"The name by which this party is commonly known in day to day use. For example, a shortening of their legal\nname or a nickname that they commonly use. This is \"non-official\". However, it is acceptable for this field\nto be set to the same as `legalName`.\n","maxLength":140,"minLength":1,"type":"string"},"legalName":{"description":"The legal name by which this party is known (the \"FICA\" name). This is the full name of the party\nas found on country-issued documentation (national identity, company registration documentation etc).\n","maxLength":140,"minLength":1,"type":"string"}},"type":"object"},"PartyWithSchema":{"allOf":[{"$ref":"#/components/schemas/ZaRppRequestor"},{"$ref":"#/components/schemas/Party"}]},"ExternalCashAccountType1Code":{"description":"* `CACC` : Current - Account used to post debits and credits when no specific account has been nominated.\n* `CARD` : Card Account - Account used for credit card payments.\n* `CASH` : Cash Payment - Account used for the payment of cash.\n* `CHAR` : Charges - Account used for charges if different from the account for payment.\n* `CISH` : Cash Income - Account used for payment of income if different from the current cash account.\n* `COMM` : Commission - Account used for commission if different from the account  for payment.\n* `CPAC` : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.\n* `LLSV` : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.\n* `LOAN` : Loan - Account used for loans.\n* `MGLD` : Marginal Lending - Account used for a marginal lending facility.\n* `MOMA` : Money Market - Account used for money markets if different from the cash account.\n* `NREX` : Non-Resident External - Account used for non-resident external.\n* `ODFT` : Overdraft - Account is used for overdrafts.\n* `ONDP` : Overnight Deposit - Account used for overnight deposits.\n* `OTHR` : Other Account - Account not otherwise specified.\n* `SACC` : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.\n* `SLRY` : Salary - Accounts used for salary payments.\n* `SVGS` : Savings - Account used for savings.\n* `TAXE` : Tax - Account used for taxes if different from the account for payment.\n* `TRAN` : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.\n* `TRAS` : Cash Trading - Account used for trading if different from the current cash account.\n","enum":["CACC","CARD","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS"],"type":"string"},"AccountTypeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalCashAccountType1Code"}},"required":["value","schema"],"type":"object"},"AccountType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/AccountTypeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/AccountTypeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"BankingIdentifier":{"discriminator":{"mapping":{"GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"}],"type":"object"},"ZaRppAccountInformation":{"properties":{"creationDate":{"description":"The date when the account referenced by this proxy identifier was created.\n","format":"date-time","type":"string"},"proxy":{"$ref":"#/components/schemas/NonBankingIdentifier"},"traditionalAccountType":{"$ref":"#/components/schemas/AccountType"},"traditionalIdentifier":{"$ref":"#/components/schemas/BankingIdentifier"}},"required":["creationDate"],"type":"object"},"Amount":{"properties":{"currency":{"description":"A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.\n","pattern":"^[A-Z]{3}$","type":"string"},"value":{"description":"The payment amount in the denomination of the indicated currency, in the\nformat '<major units>.<minor units> with the number of minor units (fractional digits)\ncompliant with the number of decimal places published in ISO 4217.\nCurrency Code | Example | Valid | Notes\n--- | --- | --- | ---\nUSD | 10.0 | ✓ | Represents 10 USD and no cents.\nUSD | 10.00 | ✓ |\nUSD | 10.001 | ✗ | US dollar does not support three decimal places.\nJPY | 10.0 | ✓ | Represents 10 Japanese Yen.\nJPY | 10.1 | ✗ | Japanese Yen does not support decimal places.\n","format":"double","minimum":0,"type":"number"}},"required":["value","currency"],"type":"object"},"ZaRppIdentificationReport":{"description":"A report providing information from the lookup of a proxy in the context of the ZA RPP Payment Scheme.\n\nThis report returns information required to proceed with the clearing of funds through the use of the `proxy`\n(identifier) provided in the identifier determination request. Specifically, this report will provide the outcome\nof the lookup of said identifier, indication whether it is valid or not, as well as provide the name (\"known as\nname\") of the creditor, and the legal name of the creditor (both of these are mandatory in the ZA RPP Payment\nScheme, despite not being mandatory in this API), namely:\n  - `accountOwner.knownAsName`\n  - `accountOwner.legalName`\n","properties":{"accountAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"accountInformation":{"$ref":"#/components/schemas/ZaRppAccountInformation"},"accountOwner":{"$ref":"#/components/schemas/Party"},"outcome":{"enum":["SUCCESSFUL","FAILED"],"type":"string"},"reasonCode":{"description":"* `AB06` :\tTransaction stopped due to timeout at the Instructed Agent.\n* `AB07` :\tAgent of message is not online. Generic usage if it cannot be determined who exactly is not online.\n* `AB10` :\tAn error occured at the instructed agent\n* `AC06` :\tAccount specified is blocked, prohibiting posting of transactions against it\n* `AG01` :\tTransaction forbidden on this type of account\n* `AG03` :\tTransaction type not supported/authorized on this account.\n* `AG10` :\tAgent of message is suspended from the Real Time Payment system. Generic usage if it cannot be determined who exactly is suspended.\n* `AGNT` :\tAgent in the payment workflow is incorrect\n* `AM02` :\tSpecific transaction/message amount is greater than allowed maximum (e.g. payee proxy participant service limit exceeded\n* `CH21` :\tMandatory element is missing .\n* `DT02` :\tInvalid creation date and time in Group Header (eg, historic date) .\n* `DU03` :\tTransaction is not unique.\n* `DUPL` :\tRequest is a duplicate of another request\n* `FF02` :\tSyntax error reason is provided as narrative information in the additional reason information.\n* `FF08` :\tEnd to End Id missing or invalid .\n* `NAUT` :\tPermission to be processed is not granted\n* `NOOR` :\tOriginal SCT never received\n* `PD01` :\tDomain not found or invalid\n* `PD02` :\tSuspended\tDomain provided is suspended pending investigation\n* `BE23` :\tPhone number or email address, or any other proxy, used as the account proxy is unknown or invalid.\n* `PX03` :\tProxy not found in central repository\n* `PX04` :\tFormat of proxy invalid\n* `RC05` :\tBIC identifier is invalid or missing.\n* `RC08` :\tClearingSystemMemberidentifier is invalid or missing. Generic usage if cannot specify between debit or credit account .\n* `RR10` :\tCharacter set supplied not valid for the country and payment type.\n* `RR12` :\tInvalid or missing identification required within a particular country or payment type.\n* `RF01` :\tTransaction reference is not unique within the message.\n* `AC16` :\tAccount in Sequestration\n* `AC17` :\tAccount in Liquidation\n* `AC04` :\tAccount Closed\n* `AC01` :\tFormat of the account number specified is not correct\n* `MD07` :\tAccount Holder Deceased\n* `NOCM` :\tCustomer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements which render an account inactive for certain processing.\n* `BE01` :\tIdentification of end customer is not consistent with associated account number. (formerly CreditorConsistency).\n","maxLength":4,"minLength":1,"type":"string"},"reasonDescription":{"description":"A description of the reason that the identification request failed.\nNOTE: Values longer than 35 characters may be truncated due to ZA RPP scheme restrictions.\n","type":"string"},"transactionLimit":{"$ref":"#/components/schemas/Amount"}},"required":["outcome"],"type":"object"},"ZaRppIdentifierDeterminationReport":{"allOf":[{"$ref":"#/components/schemas/IdentifierDeterminationReport"},{"properties":{"instructedAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"instructingAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"instructionForCreatorAgent":{"description":"Further information related to the proxy resolution response, provided by the\nOperator, and intended for the creator agent.\n","items":{"$ref":"#/components/schemas/CreditorAgentInstruction"},"minItems":0,"type":"array"},"originalRequestor":{"$ref":"#/components/schemas/ZaRppRequestor"},"originalUetr":{"description":"The universally unique identifier provided in the original request as an end-to-end reference.\nThis identifier remains the same for all messages related to the same transaction.\n","format":"UUID","type":"string"},"originalVerificationIdentification":{"description":"The `request.verificationIdentification` as provided in the original request.\n","maxLength":35,"minLength":1,"type":"string"},"reportInformation":{"$ref":"#/components/schemas/ZaRppIdentificationReport"}},"required":["schema","originalUetr","originalVerificationIdentification","reportInformation"],"type":"object"}]},"IdentifierDeterminationResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponseMessage"},{"properties":{"report":{"$ref":"#/components/schemas/IdentifierDeterminationReport"},"schema":{"enum":["IdentifierDeterminationResponse"],"type":"string"}},"required":["report","schema"],"type":"object"}]}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example: Successful Response"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-openapi/epc-cicd/epc-elpapi-partner-redoc.yaml","operationId":"inboundSynchronousIdentifierDetermination","exampleKey":"Successful-ZA-RPP-Proxy-Resolution-Response","language":"Payload","parameters":{},"options":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"NOTE"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentifierDeterminationRequest"]}," operation is synchronous in nature and you must respond within 1 second."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"duplicate-or-multiple-proxy-resolution-requests"},"children":["Duplicate or Multiple Proxy Resolution Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may sometimes receive more than one proxy resolution request for the same payment. Here is an example of how this may happen:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A payer wishes to make a payment to you, and their sending bank sends you a proxy resolution request via Electrum. You return a positive proxy resolution response, and this is presented to the payer. The payer takes some time to confirm the payment (perhaps they wish to confirm some payment detail, for example). Once the payer does confirm the payment, the bank sends you another proxy resolution before initiating the clearing step. This second resolution is not presented to the payer. It is simply used as an internal safety check between bank and corporate client, to ensure that nothing has changed in between the times when the payer saw the proxy resolution results and confirmed that they wished to pay."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You need to know the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A proxy resolution can be considered as a type of lookup, an independent transaction which has no financial impact. It does not have to be followed by a clearing step."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You may receive multiple proxy resolution requests for the same payment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each new proxy resolution will contain a different UETR. Therefore, do not try to match a specific payment completion step to a specific UETR. The clearing message will contain all necessary payment details, including the UETR of the proxy on which the payment is based."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling"},"children":["Error Handling"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"technical-error"},"children":["Technical Error"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you experience a technical error and are unable to process the request, then respond with an appropriate failure response as described in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/epc/public/error-handling"},"children":["Error Handling and Failure Responses"]}," section."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"negative-outcome"},"children":["Negative Outcome"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are able to process the request, but the result is negative, then respond with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentifierDeterminationResponse"]}," that includes appropriate values for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.outcome"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.reasonCode"]},". Electrum will respond to the scheme that the transaction was unsuccessful. No further action from you is required for this transaction."]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example: Unsuccessful Response"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-openapi/epc-cicd/epc-elpapi-partner-redoc.yaml","operationId":"inboundSynchronousIdentifierDetermination","exampleKey":"Unsuccessful-ZA-RPP-Proxy-Resolution-Response","language":"Payload","parameters":{},"options":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"report.reportInformation.reasonCode Value and Description"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report.reportInformation.reasonCode"]}," Value and Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired proxy."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BE23"]}," (Account Proxy Invalid)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The account or wallet linked to a given proxy is blocked, closed, or non-compliant."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AC04"]}," (Closed Account Number)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AC06"]}," (Blocked Account Number)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOCM"]}," (Customer Account Non-Compliant with Regulatory Requirements)"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The account linked to a given proxy cannot accept payment receipts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AG01"]}," (Transaction Forbidden)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AG03"]}," (Transaction Not Supported)"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction (such as a proxy resolution request) is not allowed for the account linked to a given proxy."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AG01"]}," (Transaction Forbidden)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AG03"]}," (Transaction Not Supported)"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error at corporate client."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FF10"]}," (Bank System Processing Error)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FF11"]}," (Clearing Request Aborted)"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Technical errors relating to the transaction message."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CH21"]}," (Mandatory Element Missing)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DT02"]}," (Invalid Creation Date and Time)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DU03"]}," (Transaction Not Unique)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DUPL"]}," (Duplicate Request)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FF02"]}," (Syntax Error)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FF08"]}," (Invalid or Missing End-to-End ID)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PX04"]}," (Proxy Format Invalid)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RR10"]}," (Invalid Character Set)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RF01"]}," (Transaction Reference Not Unique)"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"timeout"},"children":["Timeout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If Electrum does not receive any response from you within the appropriate time limit then Electrum will respond to the scheme that the transaction was unsuccessful. No further action is required from you."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"clearing"},"children":["Clearing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After the clearing of an inbound payment has been completed (either successfully or unsuccessfully) at the sponsor bank, Electrum will send an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," request to you to notify you of the payment. At this point you can update your own systems to reflect the payment."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum sends you an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/credit-transfer/inboundcredittransfercompletion"},"children":["message"]},", conforming to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentStatusReport"]}," schema, that includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status.outcome"]}," field with the final outcome of the payment."]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["PaymentStatusReport Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/PaymentStatusReport"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PaymentStatusReport"},"MessageIdentifiers":{"description":"Holds a point-to-point unique message identification string as well as a message's creation date time.\n","properties":{"creationDateTime":{"description":"The date and time at which the message was created, in senders local timezone or UTC.\nThe date *must* be formatted as defined by `date-time` in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\n","format":"date-time","type":"string"},"messageIdentification":{"description":"A reference used to unambiguously identify the message between the sending and receiving party.\nTake note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.\n","maxLength":35,"type":"string"}},"required":["messageIdentification","creationDateTime"],"type":"object"},"SupplementaryData":{"additionalProperties":{"type":"string"},"description":"A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.\n","type":"object"},"BaseMessage":{"description":"A model containing the foundational elements shared across messages and generally expected in a message used\nduring processing with the Electrum Regulated Payments API.\n","properties":{"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"supplementaryData":{"$ref":"#/components/schemas/SupplementaryData"}},"required":["messageIdentifiers"],"type":"object"},"BaseResponseMessage":{"allOf":[{"$ref":"#/components/schemas/BaseMessage"},{"description":"An extension of `BaseMessage` which includes additional information pertinent to an asynchronous response\nmessage. In particular, original message identifiers.\n","properties":{"originalMessageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"}},"required":["originalMessageIdentifiers"],"type":"object"}]},"TransactionIdentifiers":{"description":"Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.\n","properties":{"endToEndIdentification":{"description":"Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\nNote: this is distinct from the UETR.\n","maxLength":35,"type":"string"},"instructionIdentification":{"description":"Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction. The instruction identification is a point to point \nreference that can be used between the instructing party and the instructed party to refer\nto the individual instruction. It can be included in several messages related to the instruction.\n","maxLength":35,"type":"string"},"transactionIdentification":{"description":"Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level.\nUsage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.\n","maxLength":35,"type":"string"},"uetr":{"description":"Universally unique identifier to provide an end-to-end reference of a payment transaction.\nThis identifier remains the same for all messages related to the same transaction.\n","format":"UUID","type":"string"}},"required":["endToEndIdentification","uetr"],"type":"object"},"BaseTransactionResponseMessage":{"allOf":[{"$ref":"#/components/schemas/BaseResponseMessage"},{"description":"An extension of `BaseTransactionMessage` which includes additional information pertinent to an asynchronous\nresponse message. In particular, original message identifiers.\n","properties":{"transactionIdentifiers":{"$ref":"#/components/schemas/TransactionIdentifiers"}},"required":["transactionIdentifiers"],"type":"object"}]},"CustomIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"maxLength":2048,"minLength":1,"type":"string"}},"required":["value"],"type":"object"}]},"NonBankingIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"properties":{"namespace":{"description":"An identifier's namespace provides a context for the identifier to distinguish different identifiers which\nmay have the same value but be intended to identify different accounts. For example, a bank may use the same\nMSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.\n\nThis may be used by the following schemes:\n  - ZA_RPP\n","maxLength":40,"minLength":1,"type":"string"},"schema":{"description":"Indicates the schema of the identifier, e.g. `MOBILE`, `CUSTOM`.","type":"string"}},"required":["schema"],"type":"object"},"PhoneNumber":{"pattern":"^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$","type":"string"},"MobileNumberIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}},"required":["value"],"type":"object"}]},"FinancialInstitutionIdentifier":{"properties":{"bicfi":{"description":"A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as\ndescribed in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)\n","pattern":"^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$","type":"string"},"memberId":{"description":"Identification of a member of a clearing system.","maxLength":35,"type":"string"},"namespaces":{"items":{"description":"An identifier's namespace provides a context for the identifier to distinguish different identifiers which\nmay have the same value but be intended to identify different accounts. For example, a bank may use the same\nMSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.\n\nThis may be used by the following schemes:\n  - ZA_RPP\n","maxLength":40,"minLength":1,"type":"string"},"type":"array"},"schema":{"description":"Indicates the account identifier is a Financial Institution Identifier, always `FII`","type":"string"}},"required":["schema"],"type":"object"},"ExternalAccountIdentificationCode":{"description":"* `AIIN`: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).\n* `BBAN`: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.\n* `CUID`: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.\n* `UPIC`: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.\n","enum":["AIIN","BBAN","CUID","UPIC"],"type":"string"},"GenericAccountIdentificationSchemeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalAccountIdentificationCode"}},"required":["value","schema"],"type":"object"},"ProprietaryValueLiteral":{"description":"A proprietary value.","maxLength":35,"type":"string"},"ProprietaryValue":{"description":"A model that describes a proprietary value assigned by some party, the purpose of which is to provide for the\npossibility of parties using values that are not standardised.\n","properties":{"schema":{"description":"Identifies the value as being proprietary (i.e. not published in an external list). Always `PROPRIETARY`\n","type":"string"},"value":{"$ref":"#/components/schemas/ProprietaryValueLiteral"}},"required":["value","schema"],"type":"object"},"GenericAccountIdentificationScheme":{"description":"Identifies the scheme that defines the identification of a generic account.","discriminator":{"mapping":{"CODE":"#/components/schemas/GenericAccountIdentificationSchemeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/GenericAccountIdentificationSchemeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"GenericAccountIdentifier":{"properties":{"issuer":{"description":"The entity that assigns the identification","maxLength":35,"type":"string"},"schema":{"description":"Identifies this account identifier as generic, always `GENERIC`","type":"string"},"scheme":{"$ref":"#/components/schemas/GenericAccountIdentificationScheme"},"value":{"maxLength":40,"minLength":1,"type":"string"}},"required":["schema","value"],"type":"object"},"IBAN":{"description":"An identifier used internationally by financial institutions to uniquely identify the account of a customer at\na financial institution, as described in the latest edition of the international standard ISO 13616: 2007\n","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"IBANIdentifier":{"properties":{"schema":{"description":"Indicates the account identifier is an IBAN, always `IBAN`","type":"string"},"value":{"$ref":"#/components/schemas/IBAN"}},"required":["schema","value"],"type":"object"},"AccountIdentifier":{"discriminator":{"mapping":{"CUSTOM":"#/components/schemas/CustomIdentifier","FII":"#/components/schemas/FinancialInstitutionIdentifier","GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier","MOBILE":"#/components/schemas/MobileNumberIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"},{"$ref":"#/components/schemas/MobileNumberIdentifier"},{"$ref":"#/components/schemas/CustomIdentifier"},{"$ref":"#/components/schemas/FinancialInstitutionIdentifier"}],"type":"object"},"PaymentSchemeName":{"description":"Identifies the scheme used for the payment\n* `ZA_RTC`: South African Realtime Clearing scheme.\n* `ZA_RPP`: South African Realtime Payments Platform scheme.\n* `ZA_EFT`: South African Electronic Funds Transfer scheme.\n* `ZA_AC` : South African Authenticated Collections scheme.\n* `ZA_RMS`: South African Registered Mandate Service scheme.\n* `CBPR_PLUS`: Cross-Border Payments and Reporting Plus.\n","enum":["ZA_RTC","ZA_RPP","ZA_EFT","ZA_AC","ZA_RMS","CBPR_PLUS"],"type":"string"},"AccountIdentification":{"description":"Holds details pertaining to an identifier of an account or store of value.","properties":{"accountKnownAs":{"description":"A name or label of the account.","maxLength":40,"type":"string"},"identifier":{"$ref":"#/components/schemas/AccountIdentifier"},"registeredSchemes":{"description":"The list of schemes with which the identifier is registered.","items":{"$ref":"#/components/schemas/PaymentSchemeName"},"type":"array"}},"required":["identifier"],"type":"object"},"AddressTypeCode":{"description":"* `ADDR`: A postal address.\n* `PBOX`: A postal office (PO) box address.\n* `HOME`: A (residential) home address.\n* `BIZZ`: A business address.\n* `MLTO`: Address to which mail is sent.\n* `DLVY`: Address to which delivery is to take place\n","enum":["ADDR","PBOX","HOME","BIZZ","MLTO","DLVY"],"type":"string"},"CountryCode":{"description":"A code to identify a country, a dependency, or another area of particular geopolitical interest,\non the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n","pattern":"[A-Z]{2,2}","type":"string"},"PostalAddress":{"properties":{"addressLine":{"items":{"maxLength":70,"minLength":1,"type":"string"},"maxItems":7,"minItems":0,"type":"array"},"addressType":{"$ref":"#/components/schemas/AddressTypeCode"},"buildingName":{"maxLength":35,"minLength":1,"type":"string"},"buildingNumber":{"maxLength":16,"minLength":1,"type":"string"},"country":{"$ref":"#/components/schemas/CountryCode"},"countrySubDivision":{"maxLength":35,"minLength":1,"type":"string"},"department":{"maxLength":70,"minLength":1,"type":"string"},"districtName":{"maxLength":35,"minLength":1,"type":"string"},"floor":{"maxLength":70,"minLength":1,"type":"string"},"postBox":{"maxLength":16,"minLength":1,"type":"string"},"postCode":{"maxLength":16,"minLength":1,"type":"string"},"room":{"maxLength":70,"minLength":1,"type":"string"},"streetName":{"maxLength":70,"minLength":1,"type":"string"},"subDepartment":{"maxLength":70,"minLength":1,"type":"string"},"townLocationName":{"maxLength":35,"minLength":1,"type":"string"},"townName":{"maxLength":35,"minLength":1,"type":"string"}},"type":"object"},"BranchIdentification":{"properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"identification":{"description":"Unique and unambiguous identification of a branch of a financial institution.","type":"string"},"name":{"description":"The name by which this branch is known and is usually used to identify the branch.","maxLength":140,"type":"string"}},"required":["identification"],"type":"object"},"ExternalClearingSystemIdentification1Code":{"description":"* `MA` (MoroccoClearingSystemID): Clearing System ID used in Morocco\n* `ATBLZ` (AustrianBankleitzahl): Bank Branch code used in Austria.\n* `AUBSB` (AustralianBankStateBranchCodeBSB): Bank Branch code used in Australia.\n* `CACPA` (CanadianPaymentsAssociationPaymentRoutingNumber): Bank Branch code used in Canada.\n* `CHBCC` (SwissFinancialInstitutionIdentificationShort): Financial Institution Identification (IID) used in Switzerland, without check digit.\n* `CHSIC` (SwissFinancialInstitutionIdentificationLong): Financial Institution Identification (IID) used in Switzerland, including check digit.\n* `CNAPS` (CNAPSIdentifier): Bank Branch code used in China.\n* `DEBLZ` (GermanBankleitzahl): Bank Branch code used in Germany.\n* `ESNCC` (SpanishDomesticInterbankingCode): Bank Branch code used in Spain.\n* `GBDSC` (UKDomesticSortCode): Bank Branch code used in the UK.\n* `GRBIC` (HelenicBankIdentificationCode): Bank Branch code used in Greece.\n* `HKNCC` (HongKongBankCode): Bank Branch code used in Hong Kong.\n* `IENCC` (IrishNationalClearingCode): Bank Branch code used in Ireland.\n* `INFSC` (IndianFinancialSystemCode): Bank Branch code used in India.\n* `ITNCC` (ItalianDomesticIdentificationCode): Bank Branch code used in Italy.\n* `JPZGN` (JapanZenginClearingCode): Bank Branch code used in Japan.\n* `NZNCC` (NewZealandNationalClearingCode): Bank Branch code used in New Zealand.\n* `PLKNR` (PolishNationalClearingCode): Bank Branch code used in Poland.\n* `PTNCC` (PortugueseNationalClearingCode): Bank Branch code used in Portugal.\n* `RUCBC` (RussianCentralBankIdentificationCode): Bank Branch code used in Russia.\n* `SESBA` (SwedenBankgiroClearingCode): Bank Branch code used in Sweden.\n* `SGIBG` (IBGSortCode): Bank Branch code used in Singapore.\n* `THCBC` (ThaiCentralBankIdentificationCode): Bank Identification code used in Thailand.\n* `TWNCC` (FinancialInstitutionCode): Bank Branch code used in Taiwan.\n* `USABA` (UnitedStatesRoutingNumberFedwireNACHA): Routing Transit number assigned by the ABA for US financial institutions.\n* `USPID` (CHIPSParticipantIdentifier): Bank identifier used by CHIPs in the US.\n* `ZANCC` (SouthAfricanNationalClearingCode): Bank Branch code used in South Africa.\n* `NZRSA` (NewZealandRTGSClearingCode): RTGS settlement account used in New Zealand.\n* `MZBMO` (BancoDeMocambiqueRTGS): Banco de Mocambique RTGS system.\n* `CNCIP` (CrossBorderInterbankPaymentSystem): Chinese Cross-border Interbank Payment System (CIPS) Identifier.\n* `KRBOK` (SouthKoreaCentralBankIdentificationCode): Participant Institution code used by BOK-Wire+ in South Korea.\n* `BRISP` (BrazilianBankIdentificationCode): Bank Identification code used in Brazil (ISPB).\n* `NACSC` (NamibiaClearingSystemCode): Clearing system Identification code used in Namibia.\n* `ZWTSS` (ZimbabweClearingSystemCode): System Identification Code used in the Zimbabwe settlement system.\n* `AD` (AndorraClearingSystemID): Clearing System ID used in Andorra\n* `EGNCC` (EgyptianNationalClearingCode): RTGS Clearing system Identification code used in Egypt.\n* `AE` (UnitedArabEmiratesClearingSystemID): Clearing System ID used in United Arab Emirates\n* `AF` (AfghanistanClearingSystemID): Clearing System ID used in Afghanistan\n* `AI` (AntiguaandBermudaClearingSystemID): Clearing System ID used in Antigua and Bermuda\n* `AL` (AlbaniaClearingSystemID): Clearing System ID used in Albania\n* `AM` (ArmeniaClearingSystemID): Clearing System ID used in Armenia\n* `AO` (AngolaClearingSystemID): Clearing System ID used in Angola\n* `AR` (ArgentinaClearingSystemID): Clearing System ID used in Argentina\n* `AS` (AmericanSamoaClearingSystemID): Clearing System ID used in American Samoa\n* `AW` (ArubaClearingSystemID): Clearing System ID used in Aruba\n* `AZ` (AzerbaijanClearingSystemID): Clearing System ID used in Azerbaijan\n* `BA` (BosniaandHerzegovinaClearingSystemID): Clearing System ID used in Bosnia and Herzegovina\n* `BD` (BangladeshClearingSystemID): Clearing System ID used in Bangladesh\n* `BG` (BulgariaClearingSystemID): Clearing System ID used in Bulgaria\n* `BH` (BahrainClearingSystemID): Clearing System ID used in Bahrain\n* `BI` (BurundiClearingSystemID): Clearing System ID used in Burundi\n* `BL` (SaintBarthelemyClearingSystemID): Clearing System ID used in Saint Barthelemy\n* `BM` (BermudaClearingSystemID): Clearing System ID used in Bermuda\n* `BN` (BruneiDarussalamClearingSystemID): Clearing System ID used in Brunei Darussalam\n* `BO` (BoliviaClearingSystemID): Clearing System ID used in Bolivia\n* `BS` (BahamasClearingSystemID): Clearing System ID used in Bahamas\n* `BT` (BhutanClearingSystemID): Clearing System ID used in Bhutan\n* `BW` (BotswanaClearingSystemID): Clearing System ID used in Botswana\n* `BY` (BelarusClearingSystemID): Clearing System ID used in Belarus\n* `BZ` (BelizeClearingSystemID): Clearing System ID used in Belize\n* `CD` (DemocraticRepublicofTheCongoClearingSystemID): Clearing System ID used in Democratic Republic of The Congo\n* `CL` (ChileClearingSystemID): Clearing System ID used in Chile\n* `CO` (ColombiaClearingSystemID): Clearing System ID used in Colombia\n* `CR` (CostaRicaClearingSystemID): Clearing System ID used in Costa Rica\n* `CV` (CaboVerdeClearingSystemID): Clearing System ID used in Cabo Verde\n* `CW` (CuracaoClearingSystemID): Clearing System ID used in Curacao\n* `CY` (CyprusClearingSystemID): Clearing System ID used in Cyprus\n* `CZ` (CzechRepublicClearingSystemID): Clearing System ID used in Czech Republic\n* `DO` (DominicanRepublicClearingSystemID): Clearing System ID used in Dominican Republic\n* `DZ` (AlgeriaClearingSystemID): Clearing System ID used in Algeria\n* `EC` (EcuadorClearingSystemID): Clearing System ID used in Ecuador\n* `EE` (EstoniaClearingSystemID): Clearing System ID used in Estonia\n* `GE` (GeorgiaClearingSystemID): Clearing System ID used in Georgia\n* `GH` (GhanaClearingSystemID): Clearing System ID used in Ghana\n* `GN` (GuineaClearingSystemID): Clearing System ID used in Guinea\n* `GT` (GuatemalaClearingSystemID): Clearing System ID used in Guatemala\n* `GY` (GuyanaClearingSystemID): Clearing System ID used in Guyana\n* `HN` (HondurasClearingSystemID): Clearing System ID used in Honduras\n* `HR` (CroatiaClearingSystemID): Clearing System ID used in Croatia\n* `HT` (HaitiClearingSystemID): Clearing System ID used in Haiti\n* `HU` (HungaryClearingSystemID): Clearing System ID used in Hungary\n* `ID` (IndonesiaClearingSystemID): Clearing System ID used in Indonesia\n* `IL` (IsraelClearingSystemID): Clearing System ID used in Israel\n* `IQ` (IraqClearingSystemID): Clearing System ID used in Iraq\n* `IS` (IcelandClearingSystemID): Clearing System ID used in Iceland\n* `JM` (JamaicaClearingSystemID): Clearing System ID used in Jamaica\n* `JO` (JordanClearingSystemID): Clearing System ID used in Jordan\n* `KE` (KenyaClearingSystemID): Clearing System ID used in Kenya\n* `KG` (TheKyrgyzRepublicClearingSystemID): Clearing System ID used in The Kyrgyz Republic\n* `KH` (CambodiaClearingSystemID): Clearing System ID used in Cambodia\n* `KM` (ComorosClearingSystemID): Clearing System ID used in Comoros\n* `KW` (KuwaitClearingSystemID): Clearing System ID used in Kuwait\n* `KZ` (KazakhstanClearingSystemID): Clearing System ID used in Kazakhstan\n* `LB` (LebanonClearingSystemID): Clearing System ID used in Lebanon\n* `LK` (SriLankaClearingSystemID): Clearing System ID used in Sri Lanka\n* `LR` (LiberiaClearingSystemID): Clearing System ID used in Liberia\n* `LS` (LesothoClearingSystemID): Clearing System ID used in Lesotho\n* `LT` (LithuaniaClearingSystemID): Clearing System ID used in Lithuania\n* `LV` (LatviaClearingSystemID): Clearing System ID used in Latvia\n* `LY` (LibyaClearingSystemID): Clearing System ID used in Libya\n* `MD` (MoldovaClearingSystemID): Clearing System ID used in Moldova\n* `ME` (MontenegroClearingSystemID): Clearing System ID used in Montenegro\n* `MG` (MadagascarClearingSystemID): Clearing System ID used in Madagascar\n* `MK` (NorthMacedoniaClearingSystemID): Clearing System ID used in North Macedonia\n* `MN` (MongoliaClearingSystemID): Clearing System ID used in Mongolia\n* `MO` (MacaoClearingSystemID): Clearing System ID used in Macao\n* `MR` (MauritaniaClearingSystemID): Clearing System ID used in Mauritania\n* `MT` (MaltaClearingSystemID): Clearing System ID used in Malta\n* `MU` (MauritiusClearingSystemID): Clearing System ID used in Mauritius\n* `MW` (MalawiClearingSystemID): Clearing System ID used in Malawi\n* `MX` (MexicoClearingSystemID): Clearing System ID used in Mexico\n* `MY` (MalaysiaClearingSystemID): Clearing System ID used in Malaysia\n* `NG` (NigeriaClearingSystemID): Clearing System ID used in Nigeria\n* `NI` (NicaraguaClearingSystemID): Clearing System ID used in Nicaragua\n* `NP` (NepalClearingSystemID): Clearing System ID used in Nepal\n* `OM` (OmanClearingSystemID): Clearing System ID used in Oman\n* `PA` (PanamaClearingSystemID): Clearing System ID used in Panama\n* `PE` (PeruClearingSystemID): Clearing System ID used in Peru\n* `PG` (PapuaNewGuineaClearingSystemID): Clearing System ID used in Papua New Guinea\n* `PH` (PhilippinesClearingSystemID): Clearing System ID used in Philippines\n* `PK` (PakistanClearingSystemID): Clearing System ID used in Pakistan\n* `PS` (PalestineClearingSystemID): Clearing System ID used in Palestine\n* `PY` (ParaguayClearingSystemID): Clearing System ID used in Paraguay\n* `QA` (QatarClearingSystemID): Clearing System ID used in Qatar\n* `RO` (RomaniaClearingSystemID): Clearing System ID used in Romania\n* `RS` (SerbiaClearingSystemID): Clearing System ID used in Serbia\n* `RW` (RwandaClearingSystemID): Clearing System ID used in Rwanda\n* `SA` (SaudiArabiaClearingSystemID): Clearing System ID used in Saudi Arabia\n* `SC` (SeychellesClearingSystemID): Clearing System ID used in Seychelles\n* `SD` (SudanClearingSystemID): Clearing System ID used in Sudan\n* `SI` (SloveniaClearingSystemID): Clearing System ID used in Slovenia\n* `SK` (SlovakiaClearingSystemID): Clearing System ID used in Slovakia\n* `SL` (SierraLeoneClearingSystemID): Clearing System ID used in Sierra Leone\n* `ST` (SaoTomeandPrincipeClearingSystemID): Clearing System ID used in Sao Tome and Principe\n* `SV` (ElSalvadorClearingSystemID): Clearing System ID used in El Salvador\n* `SZ` (EswatiniClearingSystemID): Clearing System ID used in Eswatini\n* `TJ` (TajikistanClearingSystemID): Clearing System ID used in Tajikistan\n* `TL` (Timor): LesteClearingSystemID\tClearing System ID used in Timor-Leste\n* `TM` (TurkmenistanClearingSystemID): Clearing System ID used in Turkmenistan\n* `TN` (TunisiaClearingSystemID): Clearing System ID used in Tunisia\n* `TR` (TurkeyClearingSystemID): Clearing System ID used in Turkey\n* `TT` (TrinidadandTobagoClearingSystemID): Clearing System ID used in Trinidad and Tobago\n* `TZ` (TanzaniaClearingSystemID): Clearing System ID used in Tanzania\n* `UA` (UkraineClearingSystemID): Clearing System ID used in Ukraine\n* `UG` (UgandaClearingSystemID): Clearing System ID used in Uganda\n* `UY` (UruguayClearingSystemID): Clearing System ID used in Uruguay\n* `UZ` (UzbekistanClearingSystemID): Clearing System ID used in Uzbekistan\n* `VA` (VaticanCityClearingSystemID): Clearing System ID used in Vatican City\n* `VE` (VenezuelaClearingSystemID): Clearing System ID used in Venezuela\n* `VN` (VietnamClearingSystemID): Clearing System ID used in Vietnam\n* `XK` (KosovoClearingSystemID): Clearing System ID used in Kosovo\n* `ZM` (ZambiaClearingSystemID): Clearing System ID used in Zambia\n* `MARPA` (MoroccoRTGSParticipantIdentificationCode): RTGS participant identification code used in the Kingdom of Morocco.\n* `MARAC` (MoroccoRTGSNationalClearingCode): RTGS clearing system identification used in the Kingdom of Morocco.\n","enum":["MA","ATBLZ","AUBSB","CACPA","CHBCC","CHSIC","CNAPS","DEBLZ","ESNCC","GBDSC","GRBIC","HKNCC","IENCC","INFSC","ITNCC","JPZGN","NZNCC","PLKNR","PTNCC","RUCBC","SESBA","SGIBG","THCBC","TWNCC","USABA","USPID","ZANCC","NZRSA","MZBMO","CNCIP","KRBOK","BRISP","NACSC","ZWTSS","AD","EGNCC","AE","AF","AI","AL","AM","AO","AR","AS","AW","AZ","BA","BD","BG","BH","BI","BL","BM","BN","BO","BS","BT","BW","BY","BZ","CD","CL","CO","CR","CV","CW","CY","CZ","DO","DZ","EC","EE","GE","GH","GN","GT","GY","HN","HR","HT","HU","ID","IL","IQ","IS","JM","JO","KE","KG","KH","KM","KW","KZ","LB","LK","LR","LS","LT","LV","LY","MD","ME","MG","MK","MN","MO","MR","MT","MU","MW","MX","MY","NG","NI","NP","OM","PA","PE","PG","PH","PK","PS","PY","QA","RO","RS","RW","SA","SC","SD","SI","SK","SL","ST","SV","SZ","TJ","TL","TM","TN","TR","TT","TZ","UA","UG","UY","UZ","VA","VE","VN","XK","ZM","MARPA","MARAC"],"type":"string"},"ClearingSystemCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalClearingSystemIdentification1Code"}},"required":["schema","value"],"type":"object"},"ClearingSystemIdentification":{"discriminator":{"mapping":{"CODE":"#/components/schemas/ClearingSystemCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/ClearingSystemCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"ClearingSystemMemberIdentification":{"properties":{"clearingSystem":{"$ref":"#/components/schemas/ClearingSystemIdentification"},"memberId":{"description":"Identification of a member of a clearing system.","maxLength":35,"type":"string"}},"required":["memberId"],"type":"object"},"InstitutionIdentification":{"properties":{"additionalIdentifications":{"items":{"$ref":"#/components/schemas/AccountIdentification"},"type":"array"},"address":{"$ref":"#/components/schemas/PostalAddress"},"bicfi":{"description":"A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as\ndescribed in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)\n","pattern":"^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$","type":"string"},"branch":{"$ref":"#/components/schemas/BranchIdentification"},"clearingSystemMemberId":{"$ref":"#/components/schemas/ClearingSystemMemberIdentification"},"companyRegistration":{"deprecated":true,"description":"A unique identifier assigned to a company or organisation by a duly appointed authority within a country.","maxLength":35,"type":"string"},"lei":{"description":"An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"memberId":{"deprecated":true,"description":"Deprecated. Please use the preferred `clearingSystemMemberId.memberId` instead.\nIdentification of a member of a clearing system.\n","maxLength":35,"type":"string"},"name":{"description":"Name by which an institution is known and which is usually used to identify that institution","maxLength":140,"type":"string"}},"type":"object"},"StatusReasonTypeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `ACCC` : AcceptedSettlementCompletedCreditorAccount\n* `ACCP` : AcceptedCustomerProfile\n* `ACSC` : AcceptedSettlementCompletedDebtorAccount\n* `ACTC` : AcceptedTechnicalValidation\n* `ACWP` : AcceptedWithoutPosting\n* `ACSP` : AcceptedSettlementInProcess\n* `ACWC` : AcceptedWithChange\n* `AB01` : AbortedClearingTimeout\n* `AB02` : AbortedClearingFatalError\n* `AB03` : AbortedSettlementTimeout\n* `AB04` : AbortedSettlementFatalError\n* `AB05` : TimeoutCreditorAgent\n* `AB06` : TimeoutInstructedAgent\n* `AB07` : OfflineAgent\n* `AB08` : OfflineCreditorAgent\n* `AB09` : ErrorCreditorAgent\n* `AB10` : ErrorInstructedAgent\n* `AB11` : TimeoutDebtorAgent\n* `AC01` : IncorrectAccountNumber\n* `AC02` : InvalidDebtorAccountNumber\n* `AC03` : InvalidCreditorAccountNumber\n* `AC04` : ClosedAccountNumber\n* `AC05` : ClosedDebtorAccountNumber\n* `AC06` : BlockedAccount\n* `AC07` : ClosedCreditorAccountNumber\n* `AC08` : InvalidBranchCode\n* `AC09` : InvalidAccountCurrency\n* `AC10` : InvalidDebtorAccountCurrency\n* `AC11` : InvalidCreditorAccountCurrency\n* `AC12` : InvalidAccountType\n* `AC13` : InvalidDebtorAccountType\n* `AC14` : InvalidCreditorAccountType\n* `AC15` : AccountDetailsChanged\n* `AC16` : CardNumberInvalid\n* `AC17` : AccountInLiquidation\n* `AEXR` : AlreadyExpiredRTP\n* `AG01` : TransactionForbidden\n* `AG02` : InvalidBankOperationCode\n* `AG03` : TransactionNotSupported\n* `AG04` : InvalidAgentCountry\n* `AG05` : InvalidDebtorAgentCountry\n* `AG06` : InvalidCreditorAgentCountry\n* `AG07` : UnsuccessfulDirectDebit\n* `AG08` : InvalidAccessRights\n* `AG09` : PaymentNotReceived\n* `AG10` : AgentSuspended\n* `AG11` : CreditorAgentSuspended\n* `AG12` : NotAllowedBookTransfer\n* `AG13` : ForbiddenReturnPayment\n* `AGNT` : IncorrectAgent\n* `ALAC` : AlreadyAcceptedRTP\n* `AM01` : ZeroAmount\n* `AM02` : NotAllowedAmount\n* `AM03` : NotAllowedCurrency\n* `AM04` : InsufficientFunds\n* `AM05` : Duplication\n* `AM06` : TooLowAmount\n* `AM07` : BlockedAmount\n* `AM09` : WrongAmount\n* `AM10` : InvalidControlSum\n* `AM11` : InvalidTransactionCurrency\n* `AM12` : InvalidAmount\n* `AM13` : AmountExceedsClearingSystemLimit\n* `AM14` : AmountExceedsAgreedLimit\n* `AM15` : AmountBelowClearingSystemMinimum\n* `AM16` : InvalidGroupControlSum\n* `AM17` : InvalidPaymentInfoControlSum\n* `AM18` : InvalidNumberOfTransactions\n* `AM19` : InvalidGroupNumberOfTransactions\n* `AM20` : InvalidPaymentInfoNumberOfTransactions\n* `AM21` : LimitExceeded\n* `AM22` : ZeroAmountNotApplied\n* `AM23` : AmountExceedsSettlementLimit\n* `APAR` : AlreadyPaidRTP\n* `ARDT` : AlreadyReturnedTransaction\n* `ARFR` : AlreadyRefusedRTP\n* `ARJR` : AlreadyRejectedRTP\n* `ATNS` : AttachmentsNotSupported\n* `BE01` : InconsistentWithEndCustomer\n* `BE04` : MissingCreditorAddress\n* `BE05` : UnrecognisedInitiatingParty\n* `BE06` : UnknownEndCustomer\n* `BE07` : MissingDebtorAddress\n* `BE08` : MissingDebtorName\n* `BE09` : InvalidCountry\n* `BE10` : InvalidDebtorCountry\n* `BE11` : InvalidCreditorCountry\n* `BE12` : InvalidCountryOfResidence\n* `BE13` : InvalidDebtorCountryOfResidence\n* `BE14` : InvalidCreditorCountryOfResidence\n* `BE15` : InvalidIdentificationCode\n* `BE16` : InvalidDebtorIdentificationCode\n* `BE17` : InvalidCreditorIdentificationCode\n* `BE18` : InvalidContactDetails\n* `BE19` : InvalidChargeBearerCode\n* `BE20` : InvalidNameLength\n* `BE21` : MissingName\n* `BE22` : MissingCreditorName\n* `BE23` : AccountProxyInvalid\n* `CERI` : CheckERI\n* `CH03` : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture\n* `CH04` : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast\n* `CH07` : ElementIsNotToBeUsedAtB-andC-Level\n* `CH09` : MandateChangesNotAllowed\n* `CH10` : InformationOnMandateChangesMissing\n* `CH11` : CreditorIdentifierIncorrect\n* `CH12` : CreditorIdentifierNotUnambiguouslyAtTransaction-Level\n* `CH13` : OriginalDebtorAccountIsNotToBeUsed\n* `CH14` : OriginalDebtorAgentIsNotToBeUsed\n* `CH15` : ElementContentIncludesMoreThan140Characters\n* `CH16` : ElementContentFormallyIncorrect\n* `CH17` : ElementNotAdmitted\n* `CH19` : ValuesWillBeSetToNextTARGETday\n* `CH20` : DecimalPointsNotCompatibleWithCurrency\n* `CH21` : RequiredCompulsoryElementMissing\n* `CH22` : COREandB2BwithinOnemessage\n* `CHQC` : ChequeSettledOnCreditorAccount\n* `CN01` : AuthorisationCancelled\n* `CNOR` : CreditorBankIsNotRegistered\n* `CURR` : IncorrectCurrency\n* `CUST` : RequestedByCustomer\n* `DNOR` : DebtorBankIsNotRegistered\n* `DS01` : ElectronicSignaturesCorrect\n* `DS02` : OrderCancelled\n* `DS03` : OrderNotCancelled\n* `DS04` : OrderRejected\n* `DS05` : OrderForwardedForPostprocessing\n* `DS06` : TransferOrder\n* `DS07` : ProcessingOK\n* `DS08` : DecompressionError\n* `DS09` : DecryptionError\n* `DS0A` : DataSignRequested\n* `DS0B` : UnknownDataSignFormat\n* `DS0C` : SignerCertificateRevoked\n* `DS0D` : SignerCertificateNotValid\n* `DS0E` : IncorrectSignerCertificate\n* `DS0F` : SignerCertificationAuthoritySignerNotValid\n* `DS0G` : NotAllowedPayment\n* `DS0H` : NotAllowedAccount\n* `DS0K` : NotAllowedNumberOfTransaction\n* `DS10` : Signer1CertificateRevoked\n* `DS11` : Signer1CertificateNotValid\n* `DS12` : IncorrectSigner1Certificate\n* `DS13` : SignerCertificationAuthoritySigner1NotValid\n* `DS14` : UserDoesNotExist\n* `DS15` : IdenticalSignatureFound\n* `DS16` : PublicKeyVersionIncorrect\n* `DS17` : DifferentOrderDataInSignatures\n* `DS18` : RepeatOrder\n* `DS19` : ElectronicSignatureRightsInsufficient\n* `DS20` : Signer2CertificateRevoked\n* `DS21` : Signer2CertificateNotValid\n* `DS22` : IncorrectSigner2Certificate\n* `DS23` : SignerCertificationAuthoritySigner2NotValid\n* `DS24` : WaitingTimeExpired\n* `DS25` : OrderFileDeleted\n* `DS26` : UserSignedMultipleTimes\n* `DS27` : UserNotYetActivated\n* `DT01` : InvalidDate\n* `DT02` : InvalidCreationDate\n* `DT03` : InvalidNonProcessingDate\n* `DT04` : FutureDateNotSupported\n* `DT05` : InvalidCutOffDate\n* `DT06` : ExecutionDateChanged\n* `DU01` : DuplicateMessageID\n* `DU02` : DuplicatePaymentInformationID\n* `DU03` : DuplicateTransaction\n* `DU04` : DuplicateEndToEndID\n* `DU05` : DuplicateInstructionID\n* `DUPL` : DuplicatePayment\n* `ED01` : CorrespondentBankNotPossible\n* `ED03` : BalanceInfoRequest\n* `ED05` : SettlementFailed\n* `ED06` : SettlementSystemNotAvailable\n* `EDTL` : ExpiryDateTooLong\n* `EDTR` : ExpiryDateTimeReached\n* `ERIN` : ERIOptionNotSupported\n* `FF01` : InvalidFileFormat\n* `FF02` : SyntaxError\n* `FF03` : InvalidPaymentTypeInformation\n* `FF04` : InvalidServiceLevelCode\n* `FF05` : InvalidLocalInstrumentCode\n* `FF06` : InvalidCategoryPurposeCode\n* `FF07` : InvalidPurpose\n* `FF08` : InvalidEndToEndId\n* `FF09` : InvalidChequeNumber\n* `FF10` : BankSystemProcessingError\n* `FF11` : ClearingRequestAborted\n* `FF12` : OriginalTransactionNotEligibleForRequestedReturn\n* `FF13` : RequestForCancellationNotFound\n* `FOCR` : FollowingCancellationRequest\n* `FR01` : Fraud\n* `FRAD` : FraudulentOrigin\n* `G000` : PaymentTransferredAndTracked\n* `G001` : PaymentTransferredAndNotTracked\n* `G002` : CreditDebitNotConfirmed\n* `G003` : CreditPendingDocuments\n* `G004` : CreditPendingFunds\n* `G005` : DeliveredWithServiceLevel\n* `G006` : DeliveredWithoutServiceLevel\n* `ID01` : CorrespondingOriginalFileStillNotSent\n* `IEDT` : IncorrectExpiryDateTime\n* `IRNR` : InitialRTPNeverReceived\n* `MD01` : NoMandate\n* `MD02` : MissingMandatoryInformationInMandate\n* `MD05` : CollectionNotDue\n* `MD06` : RefundRequestByEndCustomer\n* `MD07` : EndCustomerDeceased\n* `MS02` : NotSpecifiedReasonCustomerGenerated\n* `MS03` : NotSpecifiedReasonAgentGenerated\n* `NARR` : Narrative\n* `NERI` : NoERI\n* `NOAR` : NonAgreedRTP\n* `NOAS` : NoAnswerFromCustomer\n* `NOCM` : NotCompliantGeneric\n* `NOOR` : NoOriginalTransactionReceived\n* `NOPG` : NoPaymentGuarantee\n* `NRCH` : PayerOrPayerRTPSPNotReachable\n* `PART` : PartiallyAccepted\n* `PINS` : TypeOfPaymentInstrumentNotSupported\n* `RC01` : BankIdentifierIncorrect\n* `RC02` : InvalidBankIdentifier\n* `RC03` : InvalidDebtorBankIdentifier\n* `RC04` : InvalidCreditorBankIdentifier\n* `RC05` : InvalidBICIdentifier\n* `RC06` : InvalidDebtorBICIdentifier\n* `RC07` : InvalidCreditorBICIdentifier\n* `RC08` : InvalidClearingSystemMemberIdentifier\n* `RC09` : InvalidDebtorClearingSystemMemberIdentifier\n* `RC10` : InvalidCreditorClearingSystemMemberIdentifier\n* `RC11` : InvalidIntermediaryAgent\n* `RC12` : MissingCreditorSchemeId\n* `RCON` : RMessageConflict\n* `RECI` : ReceiverCustomerInformation\n* `REPR` : RTPReceivedCanBeProcessed\n* `RF01` : NotUniqueTransactionReference\n* `RR01` : MissingDebtorAccountOrIdentification\n* `RR02` : MissingDebtorNameOrAddress\n* `RR03` : MissingCreditorNameOrAddress\n* `RR04` : RegulatoryReason\n* `RR05` : RegulatoryInformationInvalid\n* `RR06` : TaxInformationInvalid\n* `RR07` : RemittanceInformationInvalid\n* `RR08` : RemittanceInformationTruncated\n* `RR09` : InvalidStructuredCreditorReference\n* `RR10` : InvalidCharacterSet\n* `RR11` : InvalidDebtorAgentServiceID\n* `RR12` : InvalidPartyID\n* `RTNS` : RTPNotSupportedForDebtor\n* `RUTA` : ReturnUponUnableToApply\n* `S000` : ValidRequestForCancellationAcknowledged\n* `S001` : UETRFlaggedForCancellation\n* `S002` : NetworkStopOfUETR\n* `S003` : RequestForCancellationForwarded\n* `S004` : RequestForCancellationDeliveryAcknowledgement\n* `SL01` : SpecificServiceOfferedByDebtorAgent\n* `SL02` : SpecificServiceOfferedByCreditorAgent\n* `SL03` : ServiceofClearingSystem\n* `SL11` : CreditorNotOnWhitelistOfDebtor\n* `SL12` : CreditorOnBlacklistOfDebtor\n* `SL13` : MaximumNumberOfDirectDebitTransactionsExceeded\n* `SL14` : MaximumDirectDebitTransactionAmountExceeded\n* `SP01` : PaymentStopped\n* `SP02` : PreviouslyStopped\n* `SPII` : RTPServiceProviderIdentifierIncorrect\n* `TA01` : TransmissionAborted\n* `TD01` : NoDataAvailable\n* `TD02` : FileNonReadable\n* `TD03` : IncorrectFileStructure\n* `TK01` : TokenInvalid\n* `TK02` : SenderTokenNotFound\n* `TK03` : ReceiverTokenNotFound\n* `TK09` : TokenMissing\n* `TKCM` : TokenCounterpartyMismatch\n* `TKSG` : TokenSingleUse\n* `TKSP` : TokenSuspended\n* `TKVE` : TokenValueLimitExceeded\n* `TKXP` : TokenExpired\n* `TM01` : InvalidCutOffTime\n* `TS01` : TransmissionSuccessful\n* `TS04` : TransferToSignByHand\n* `UCRD` : UnknownCreditor\n* `UPAY` : UnduePayment\n","enum":["ACCC","ACCP","ACSC","ACTC","ACWP","ACSP","ACWC","AB01","AB02","AB03","AB04","AB05","AB06","AB07","AB08","AB09","AB10","AB11","AC01","AC02","AC03","AC04","AC05","AC06","AC07","AC08","AC09","AC10","AC11","AC12","AC13","AC14","AC15","AC16","AC17","AEXR","AG01","AG02","AG03","AG04","AG05","AG06","AG07","AG08","AG09","AG10","AG11","AG12","AG13","AGNT","ALAC","AM01","AM02","AM03","AM04","AM05","AM06","AM07","AM09","AM10","AM11","AM12","AM13","AM14","AM15","AM16","AM17","AM18","AM19","AM20","AM21","AM22","AM23","APAR","ARDT","ARFR","ARJR","ATNS","BE01","BE04","BE05","BE06","BE07","BE08","BE09","BE10","BE11","BE12","BE13","BE14","BE15","BE16","BE17","BE18","BE19","BE20","BE21","BE22","BE23","CERI","CH03","CH04","CH07","CH09","CH10","CH11","CH12","CH13","CH14","CH15","CH16","CH17","CH19","CH20","CH21","CH22","CHQC","CN01","CNOR","CURR","CUST","DNOR","DS01","DS02","DS03","DS04","DS05","DS06","DS07","DS08","DS09","DS0A","DS0B","DS0C","DS0D","DS0E","DS0F","DS0G","DS0H","DS0K","DS10","DS11","DS12","DS13","DS14","DS15","DS16","DS17","DS18","DS19","DS20","DS21","DS22","DS23","DS24","DS25","DS26","DS27","DT01","DT02","DT03","DT04","DT05","DT06","DU01","DU02","DU03","DU04","DU05","DUPL","ED01","ED03","ED05","ED06","EDTL","EDTR","ERIN","FF01","FF02","FF03","FF04","FF05","FF06","FF07","FF08","FF09","FF10","FF11","FF12","FF13","FOCR","FR01","FRAD","G000","G001","G002","G003","G004","G005","G006","ID01","IEDT","IRNR","MD01","MD02","MD05","MD06","MD07","MS02","MS03","NARR","NERI","NOAR","NOAS","NOCM","NOOR","NOPG","NRCH","PART","PINS","RC01","RC02","RC03","RC04","RC05","RC06","RC07","RC08","RC09","RC10","RC11","RC12","RCON","RECI","REPR","RF01","RR01","RR02","RR03","RR04","RR05","RR06","RR07","RR08","RR09","RR10","RR11","RR12","RTNS","RUTA","S000","S001","S002","S003","S004","SL01","SL02","SL03","SL11","SL12","SL13","SL14","SP01","SP02","SPII","TA01","TD01","TD02","TD03","TK01","TK02","TK03","TK09","TKCM","TKSG","TKSP","TKVE","TKXP","TM01","TS01","TS04","UCRD","UPAY"],"type":"string"}},"required":["schema","value"],"type":"object"},"StatusReasonType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/StatusReasonTypeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/StatusReasonTypeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"StatusReasonInfo":{"description":"Provides detailed information on a status reason.\n","properties":{"additionalInformation":{"description":"A human friendly description of the status reason including any further details if applicable.\n","type":"string"},"reason":{"$ref":"#/components/schemas/StatusReasonType"}},"required":["reason"],"type":"object"},"Status":{"properties":{"outcome":{"description":"- `APPROVED`: The instruction has been approved.\n- `CANCELLED`: The instruction has been cancelled.\n- `PENDING`: The instruction is pending.\n- `REJECTED`: The instruction has been rejected.\n","enum":["APPROVED","CANCELLED","PENDING","REJECTED"],"type":"string"},"reasonInfo":{"description":"A list of `StatusReasonInfo` values providing detailed reason information for the outcome.\n","items":{"$ref":"#/components/schemas/StatusReasonInfo"},"minItems":1,"type":"array"}},"required":["outcome"],"type":"object"},"BasePaymentStatusReport":{"allOf":[{"$ref":"#/components/schemas/BaseTransactionResponseMessage"},{"properties":{"instructedAgent":{"$ref":"#/components/schemas/InstitutionIdentification","description":"The instructed agent is the party receiving the status message and not the party that received the\noriginal instruction that is being reported on.\n"},"instructingAgent":{"$ref":"#/components/schemas/InstitutionIdentification","description":"The instructing agent is the party sending the status message and not the party that sent the original\ninstruction that is being reported on.\n"},"status":{"$ref":"#/components/schemas/Status"}},"required":["status"],"type":"object"}]},"BiannualFrequency":{"allOf":[{"$ref":"#/components/schemas/DayOfMonthBasedFrequency"}],"description":"Specifies the frequency of a biannual payment transaction by day of the month.\n"},"DayOfMonthBasedFrequency":{"description":"Base model for payment transaction frequencies expressed in terms of days of the month. Not expected to be\nused directly; see `MonthlyFrequency`, `QuarterlyFrequency`, `BiannualFrequency` and `YearlyFrequency`.\n","discriminator":{"mapping":{"BiannualFrequency":"#/components/schemas/BiannualFrequency","MonthlyFrequency":"#/components/schemas/MonthlyFrequency","QuarterlyFrequency":"#/components/schemas/QuarterlyFrequency","YearlyFrequency":"#/components/schemas/YearlyFrequency"},"propertyName":"schema"},"properties":{"dayOfMonth":{"description":"Specifies the day of the month on which the payment transaction is to be processed.\nNOTE: A value of `31` will be interpreted as the last day of the month.\n","maximum":31,"minimum":1,"type":"integer"},"schema":{"enum":["MonthlyFrequency","QuarterlyFrequency","BiannualFrequency","YearlyFrequency"],"type":"string"}},"required":["schema","dayOfMonth"],"type":"object"},"MonthlyFrequency":{"allOf":[{"$ref":"#/components/schemas/DayOfMonthBasedFrequency"}],"description":"Specifies the frequency of a monthly payment transaction by day of the month.\n"},"QuarterlyFrequency":{"allOf":[{"$ref":"#/components/schemas/DayOfMonthBasedFrequency"}],"description":"Specifies the frequency of a quarterly payment transaction by day of the month.\n"},"YearlyFrequency":{"allOf":[{"$ref":"#/components/schemas/DayOfMonthBasedFrequency"}],"description":"Specifies the frequency of a yearly payment transaction by day of the month.\n"},"DayOfWeek":{"description":"Specifies a day of the week.\n","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"FortnightlyFrequency":{"description":"Specifies the frequency of a fortnightly payment transaction.\n","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"schema":{"enum":["FortnightlyFrequency"],"type":"string"},"week":{"description":"Identifies the week of the fortnight on which the payment transaction is to be processed.\n* FIRST_WEEK: First week of the fortnight.\n* SECOND_WEEK: Second week of the fortnight.\n","enum":["FIRST_WEEK","SECOND_WEEK"],"type":"string"}},"required":["schema","week","dayOfWeek"],"type":"object"},"MonthlyRuleFrequency":{"description":"Specifies the frequency of a monthly payment transaction by a special rule, e.g. \"the last monday of the month\".\n","properties":{"rule":{"description":"Specifies the day of the month on which the payment transaction is to be processed.\n* `LAST_MONDAY`: Last Monday of the month.\n* `LAST_TUESDAY`: Last Tuesday of the month.\n* `LAST_WEDNESDAY`: Last Wednesday of the month.\n* `LAST_THURSDAY`: Last Thursday of the month.\n* `LAST_FRIDAY`: Last Friday of the month.\n* `LAST_SATURDAY`: Last Saturday of the month.\n* `FIRST_MONDAY`: First Monday of the month.\n* `FIRST_TUESDAY`: First Tuesday of the month.\n* `FIRST_WEDNESDAY`: First Wednesday of the month.\n* `FIRST_THURSDAY`: First Thursday of the month.\n* `FIRST_FRIDAY`: First Friday of the month.\n* `FIRST_SATURDAY`: First Saturday of the month.\n* `SECOND_LAST_DAY`: Second last day of the month.\n* `LAST_DAY`: Last day of the month.\n","enum":["LAST_MONDAY","LAST_TUESDAY","LAST_WEDNESDAY","LAST_THURSDAY","LAST_FRIDAY","LAST_SATURDAY","FIRST_MONDAY","FIRST_TUESDAY","FIRST_WEDNESDAY","FIRST_THURSDAY","FIRST_FRIDAY","FIRST_SATURDAY","SECOND_LAST_DAY","LAST_DAY"],"type":"string"},"schema":{"enum":["MonthlyRuleFrequency"],"type":"string"}},"required":["schema","rule"],"type":"object"},"WeeklyFrequency":{"description":"Specifies the frequency of a weekly payment transaction.\n","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"schema":{"enum":["WeeklyFrequency"],"type":"string"}},"required":["schema","dayOfWeek"],"type":"object"},"Frequency":{"description":"Specifies the frequency of the payment transaction.\n","discriminator":{"mapping":{"BiannualFrequency":"#/components/schemas/BiannualFrequency","FortnightlyFrequency":"#/components/schemas/FortnightlyFrequency","MonthlyFrequency":"#/components/schemas/MonthlyFrequency","MonthlyRuleFrequency":"#/components/schemas/MonthlyRuleFrequency","QuarterlyFrequency":"#/components/schemas/QuarterlyFrequency","WeeklyFrequency":"#/components/schemas/WeeklyFrequency","YearlyFrequency":"#/components/schemas/YearlyFrequency"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/MonthlyFrequency"},{"$ref":"#/components/schemas/QuarterlyFrequency"},{"$ref":"#/components/schemas/BiannualFrequency"},{"$ref":"#/components/schemas/YearlyFrequency"},{"$ref":"#/components/schemas/MonthlyRuleFrequency"},{"$ref":"#/components/schemas/WeeklyFrequency"},{"$ref":"#/components/schemas/FortnightlyFrequency"}],"type":"object"},"MandateSetupReasonCode":{"description":"Reason for the direct debit mandate to allow the user to distinguish between different mandates for the\nsame creditor.\n","properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"maxLength":4,"minLength":1,"type":"string"}},"required":["schema","value"],"type":"object"},"MandateSetupReason":{"discriminator":{"mapping":{"CODE":"#/components/schemas/MandateSetupReasonCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/MandateSetupReasonCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"MandateInformation":{"description":"Provides details of the direct debit mandate signed between the creditor and the debtor.\n\nNOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate\namendments which we may need in the future. Note also that this model is not relevant to the `ZA_EFT` scheme,\nand therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour\ntracking days for EFT payments).\n","properties":{"dateOfSignature":{"description":"Date on which the direct debit mandate has been signed by the debtor.\n","format":"date","type":"string"},"electronicSignature":{"description":"A digital signature provided by the debtor.\n","maxLength":1025,"type":"string"},"finalCollectionDate":{"description":"Date of the final collection of a direct debit as per the mandate.\n","format":"date","type":"string"},"firstCollectionDate":{"description":"Date of the first collection of a direct debit as per the mandate.\n","format":"date","type":"string"},"frequency":{"$ref":"#/components/schemas/Frequency","description":"Regularity with which direct debit instructions are to be created and processed.\n"},"mandateIdentification":{"description":"Unique identification, as assigned by the creditor, to unambiguously identify the mandate.\n","maxLength":35,"type":"string"},"reason":{"$ref":"#/components/schemas/MandateSetupReason","description":"Reason for the direct debit mandate to allow the user to distinguish between different mandates for the\nsame creditor.\n"},"trackingDays":{"description":"Specifies the number of days the direct debit instruction must be tracked.\n","maximum":99,"minimum":1,"type":"integer"}},"type":"object"},"Amount":{"properties":{"currency":{"description":"A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.\n","pattern":"^[A-Z]{3}$","type":"string"},"value":{"description":"The payment amount in the denomination of the indicated currency, in the\nformat '<major units>.<minor units> with the number of minor units (fractional digits)\ncompliant with the number of decimal places published in ISO 4217.\nCurrency Code | Example | Valid | Notes\n--- | --- | --- | ---\nUSD | 10.0 | ✓ | Represents 10 USD and no cents.\nUSD | 10.00 | ✓ |\nUSD | 10.001 | ✗ | US dollar does not support three decimal places.\nJPY | 10.0 | ✓ | Represents 10 Japanese Yen.\nJPY | 10.1 | ✗ | Japanese Yen does not support decimal places.\n","format":"double","minimum":0,"type":"number"}},"required":["value","currency"],"type":"object"},"TransactionAmounts":{"properties":{"bankSettlementAmount":{"$ref":"#/components/schemas/Amount","description":"The inter-bank amount of money to be moved between the instructing and instructed agent, which may include charges\nor deductions, expressed in the currency as ordered by the initiating party\n"},"instructedAmount":{"$ref":"#/components/schemas/Amount","description":"The amount of money to be moved between the debtor and creditor, before deduction of\ncharges, expressed in the currency as ordered by the initiating party.\n"}},"required":["bankSettlementAmount"],"type":"object"},"BankingIdentifier":{"discriminator":{"mapping":{"GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"}],"type":"object"},"ExternalCashAccountType1Code":{"description":"* `CACC` : Current - Account used to post debits and credits when no specific account has been nominated.\n* `CARD` : Card Account - Account used for credit card payments.\n* `CASH` : Cash Payment - Account used for the payment of cash.\n* `CHAR` : Charges - Account used for charges if different from the account for payment.\n* `CISH` : Cash Income - Account used for payment of income if different from the current cash account.\n* `COMM` : Commission - Account used for commission if different from the account  for payment.\n* `CPAC` : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.\n* `LLSV` : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.\n* `LOAN` : Loan - Account used for loans.\n* `MGLD` : Marginal Lending - Account used for a marginal lending facility.\n* `MOMA` : Money Market - Account used for money markets if different from the cash account.\n* `NREX` : Non-Resident External - Account used for non-resident external.\n* `ODFT` : Overdraft - Account is used for overdrafts.\n* `ONDP` : Overnight Deposit - Account used for overnight deposits.\n* `OTHR` : Other Account - Account not otherwise specified.\n* `SACC` : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.\n* `SLRY` : Salary - Accounts used for salary payments.\n* `SVGS` : Savings - Account used for savings.\n* `TAXE` : Tax - Account used for taxes if different from the account for payment.\n* `TRAN` : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.\n* `TRAS` : Cash Trading - Account used for trading if different from the current cash account.\n","enum":["CACC","CARD","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS"],"type":"string"},"AccountTypeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalCashAccountType1Code"}},"required":["value","schema"],"type":"object"},"AccountType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/AccountTypeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/AccountTypeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"PaymentAccount":{"description":"Representation of an account for payment purposes.\nNote that at least one of `identification` or `proxy` is expected to be present.\n","properties":{"currency":{"description":"Identification of the currency in which the account is held.","pattern":"^[A-Z]{3}$","type":"string"},"identification":{"$ref":"#/components/schemas/BankingIdentifier"},"name":{"description":"Name of the account, as assigned by the account servicing institution, in agreement with the account owner\nin order to provide an additional means of identification of the account.\n","maxLength":70,"type":"string"},"proxy":{"$ref":"#/components/schemas/NonBankingIdentifier"},"type":{"$ref":"#/components/schemas/AccountType"}},"type":"object"},"PaymentMethod":{"description":"* `CreditTransfer` - Transfer of an amount of money in the books of the account servicer.\n* `DirectDebit` - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.\n","enum":["CreditTransfer","DirectDebit"],"type":"string"},"ExternalCategoryPurpose1Code":{"description":"* `BONU` (BonusPayment): Transaction is the payment of a bonus.\n* `CASH` (CashManagementTransfer): Transaction is a general cash management instruction.\n* `CBLK` (CardBulkClearing): A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.\n* `CCRD` (CreditCardPayment): Transaction is related to a payment of credit card.\n* `CORT` (TradeSettlementPayment): Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.\n* `DCRD` (DebitCardPayment): Transaction is related to a payment of debit card.\n* `DIVI` (Dividend): Transaction is the payment of dividends.\n* `DVPM` (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.\n* `EPAY` (Epayment): Transaction is related to ePayment.\n* `FCIN` (FeeCollectionAndInterest): Transaction is related to the payment of a fee and interest.\n* `FCOL` (FeeCollection): A service that is settling card transaction related fees between two parties.\n* `GP2P` (PersontoPersonPayment): General Person-to-Person Payment. Debtor and Creditor are natural persons.\n* `GOVT` (GovernmentPayment): Transaction is a payment to or from a government department.\n* `HEDG` (Hedging): Transaction is related to the payment of a hedging operation.\n* `ICCP` (IrrevocableCreditCardPayment): Transaction is reimbursement of credit card payment.\n* `IDCP` (IrrevocableDebitCardPayment): Transaction is reimbursement of debit card payment.\n* `INTC` (IntraCompanyPayment): Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.\n* `INTE` (Interest): Transaction is the payment of interest.\n* `LBOX` (LockboxTransactions): Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.\n* `LOAN` (Loan): Transaction is related to the transfer of a loan to a borrower.\n* `MP2B` (Commercial): Mobile P2B Payment\n* `MP2P` (Consumer): Mobile P2P Payment\n* `OTHR` (OtherPayment): Other payment purpose.\n* `PENS` (PensionPayment): Transaction is the payment of pension.\n* `RPRE` (Represented): Collection used to re-present previously reversed or returned direct debit transactions.\n* `RRCT` (ReimbursementReceivedCreditTransfer): Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.\n* `RVPM` (ReceiveAgainstPayment): Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.\n* `SALA` (SalaryPayment): Transaction is the payment of salaries.\n* `SECU` (Securities): Transaction is the payment of securities.\n* `SSBE` (SocialSecurityBenefit): Transaction is a social security benefit, ie payment made by a government to support individuals.\n* `SUPP` (SupplierPayment): Transaction is related to a payment to a supplier.\n* `TAXS` (TaxPayment): Transaction is the payment of taxes.\n* `TRAD` (Trade): Transaction is related to the payment of a trade finance transaction.\n* `TREA` (TreasuryPayment): Transaction is related to treasury operations.  E.g. financial contract settlement.\n* `VATX` (ValueAddedTaxPayment): Transaction is the payment of value added tax.\n* `WHLD` (WithHolding): Transaction is the payment of withholding tax.\n* `SWEP` (CashManagementSweepAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.\n* `TOPG` (CashManagementTopAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.\n* `ZABA` (CashManagementZeroBalanceAccount): Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.\n* `VOST` (CrossborderMIPayments): Transaction to be processed as a domestic payment instruction originated from a foreign bank.\n* `FCDT` (ForeignCurrencyDomesticTransfer): Foreign Currency Transaction that is processed between two domestic financial institutions.\n* `CIPC` (CashInPreCredit): Transaction is a direct debit for a cash order of notes and/or coins.\n* `CONC` (CashOutNotesCoins): Transaction is a direct debit for a cash order of notes and/or coins.\n* `CGWV` (CarrierGuardedWholesaleValuables): Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.\n* `SAVG` (Savings): Transfer to / from savings or to retirement account.\n* `CTDF` (DoddFrank1073Payment): Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073.\n","enum":["BONU","CASH","CBLK","CCRD","CORT","DCRD","DIVI","DVPM","EPAY","FCIN","FCOL","GP2P","GOVT","HEDG","ICCP","IDCP","INTC","INTE","LBOX","LOAN","MP2B","MP2P","OTHR","PENS","RPRE","RRCT","RVPM","SALA","SECU","SSBE","SUPP","TAXS","TRAD","TREA","VATX","WHLD","SWEP","TOPG","ZABA","VOST","FCDT","CIPC","CONC","CGWV","SAVG","CTDF"],"type":"string"},"CategoryPurposeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalCategoryPurpose1Code"}},"required":["schema","value"],"type":"object"},"CategoryPurpose":{"discriminator":{"mapping":{"CODE":"#/components/schemas/CategoryPurposeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/CategoryPurposeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"LocalInstrumentTypeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `0000` - BusinessPayment\n* `0001` - ConvertedBankPayment\n* `0002` - StandingOrder\n* `0090` - MassPaymentBeneficiary\n* `0091` - MassPaymentOurs\n* `0092` - MassPaymentShared\n* `0220` - StandingAuthorisationGeneral\n* `0221` - OneOffAuthorisation\n* `0222` - StandingAuthorisationCompanies\n* `0223` - StandingAuthorisationLotteries\n* `0224` - OneOffAuthorisationCharities\n* `0225` - OneOffAuthorisationTuitionFees\n* `0226` - OneOffAuthorisationConstructionIndustry\n* `0227` - StandingAuthorisationCompaniesWithoutDebtorRevocationRight\n* `04` - PreauthorisedDirectDebitDE\n* `05` - NonPreauthorisedDirectDebitDE\n* `08` - PreauthorisedDirectDebitOrdinaireNormalClearing4Day\n* `19` - BusinessToCustomerDirectDebit\n* `58` - BusinessToBusinessDirectDebit\n* `60` - RecoveredBillofExchangeorPromissoryNote\n* `82` - NonPreauthorisedDirectDebitAT\n* `83` - PreauthorisedDirectDebitAT\n* `85` - PreauthorisedDirectDebitAccéléréAcceleratedClearing2DayOrdinaireNormalClearing4Day\n* `89` - PreauthorisedDirectDebitVérifiéVerifiedClearing\n* `AC01` - IncorrectAccountNumber\n* `ACCEPT` - PaymentViaAcceptgiroOwnedByCurrence\n* `ADD` - AuthenticatedDirectDebit\n* `ARC` - AccountsReceivableCheck\n* `ASTI` - AncillarySystemTransferInitiation\n* `B2B` - SEPABusinessToBusinessDirectDebit\n* `B2BAMIPM` - SEPAB2BDirectDebitAMI\n* `BACP` - BackupPayment\n* `BPA` - BatchPaymentsAruba\n* `BSE` - PaperlessChequeCollection\n* `BTR` - BankTransfer\n* `CARD` - CardClearing\n* `CCD` - CashConcentrationOrDisbursementCorporateCounterparty\n* `CCI` - CashConcentrationIntragroup\n* `CHN` - TruncatedChecks\n* `CIE` - CustomerInitiatedEntry\n* `CKS` - CheckSameDaySettlementWire\n* `CLSCCPERX` - CLSClearedFXForEurex\n* `CLSCCPLCH` - CLSClearedFXForLCH\n* `COR1` - SEPADirectDebit1DaySettlement\n* `CORAMIPM` - SEPACoreDirectDebitAMI\n* `CORE` - SEPADirectDebitCore\n* `CPP` - CashPerPost\n* `CR1AMIPM` - SEPACoreD1DirectDebitAMI\n* `CRP` - CreditTransferPreferred\n* `CTP` - CustomerTransferPlus\n* `CTR` - CustomerTransfer\n* `CTX` - CorporateTradeExchange\n* `DDFA` - DirectDebitFixedAmount\n* `DDMC` - DirectDebitConfirmedElectronicMandate\n* `DDMP` - DirectDebitPaperMandateWithPaperAuthorisation\n* `DDMU` - DirectDebitUnconfirmedElectronicMandate\n* `DDNR` - CoreNoRefund\n* `DDT` - DirectDebits\n* `DEP` - DepositToSendersAccount\n* `DRB` - BankToBankDrawdownRequestOrResponseNonvalue\n* `DRC` - CustomerOrCorporateDrawdownRequestOrResponseNonvalue\n* `DRW` - DrawdownResponseValueToHonorADrawdownRequest\n* `FADAMIPM` - SEPAFADirectDebitAMI\n* `FFR` - FedFundsReturned\n* `FFS` - FedFundsSold\n* `GST` - TruncatedCreditTransfers\n* `IAT` - InternationalACH\n* `ICMC` - IncidentManagementCorrection\n* `IDEAL` - PaymentsViaInternetOwnedByCurrence\n* `IN` - CrossBorderCustomerCreditTransfer\n* `INST` - InstantCreditTransfer\n* `INSTIDEAL` - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransfer\n* `INSTNT01` - InstantCreditTransferNotTimeCritical\n* `INSTNT01IDEAL` - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferNotTimeCritical\n* `INSTTC01` - InstantCreditTransferTimeCritical\n* `INSTTC01IDEAL` - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferTimeCritical\n* `IPA` - InstantPaymentsAruba\n* `ISE` - ImageBasedChequeCollection\n* `ITP` - InstantCreditTransferPreferred\n* `MANP` - MandatedPayment\n* `NLDO` - DutchDomesticBulkPayment\n* `NLGOV` - DirectDebitInitiatedByTheGovernmentWithSpecialConditions\n* `NLUP` - DutchUrgentPayment\n* `ONCL` - Overnight\n* `PERI` - PaymentWithERI\n* `POP` - PointOfPurchase\n* `POS` - PointOfSale\n* `PPD` - PrearrangedPaymentOrDepositConsumerCounterparty\n* `RCK` - RepresentedCheckEntry\n* `RDD` - ReturnedDirectDebits\n* `RIBA` - NonPreauthorisedDirectDebitRIBA\n* `RIDO` - PreauthorisedRevocableDirectDebit\n* `RIDV` - PreauthorisedRevocableUrgentDirectDebit\n* `RTR` - ReturnedCreditTransfers\n* `SBTI` - SettlementBankTransferInitiation\n* `SCN` - RevokedTruncatedChecks\n* `SDCL` - SameDayClearedPayments\n* `SDD` - RevokedDirectDebits\n* `SDN` - PaymentsViaStandaardDigitaleNota\n* `SGT` - RevokedTruncatedCreditTransfers\n* `SRD` - RevokedReturnedDirectDebits\n* `SRT` - RevokedReturnedCreditTransfers\n* `STR` - RevokedCreditTransfers\n* `SVC` - NonValueServiceMessage\n* `TEL` - TelephoneInitiatedEntry\n* `TRF` - CreditTransfers\n* `UDD` - UnauthenticatedDirectDebit\n* `WEB` - InternetInitiatedEntry\n","enum":["0000","0001","0002",90,91,92,"0220","0221","0222","0223","0224","0225","0226","0227","04","05",8,"19","58","60","82","83","85","89","AC01","ACCEPT","ADD","ARC","ASTI","B2B","B2BAMIPM","BACP","BPA","BSE","BTR","CARD","CCD","CCI","CHN","CIE","CKS","CLSCCPERX","CLSCCPLCH","COR1","CORAMIPM","CORE","CPP","CR1AMIPM","CRP","CTP","CTR","CTX","DDFA","DDMC","DDMP","DDMU","DDNR","DDT","DEP","DRB","DRC","DRW","FADAMIPM","FFR","FFS","GST","IAT","ICMC","IDEAL","IN","INST","INSTIDEAL","INSTNT01","INSTNT01IDEAL","INSTTC01","INSTTC01IDEAL","IPA","ISE","ITP","MANP","NLDO","NLGOV","NLUP","ONCL","PERI","POP","POS","PPD","RCK","RDD","RIBA","RIDO","RIDV","RTR","SBTI","SCN","SDCL","SDD","SDN","SGT","SRD","SRT","STR","SVC","TEL","TRF","UDD","WEB"],"type":"string"}},"required":["value","schema"],"type":"object"},"LocalInstrumentType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/LocalInstrumentTypeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/LocalInstrumentTypeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"ExternalServiceLevel1Code":{"description":"* `BKTR` (BookTransaction): Payment through internal book transfer.\n* `G001` (TrackedCustomerCreditTransfer): Tracked Customer Credit Transfer.\n* `G002` (TrackedStopAndRecall): Tracked Stop and Recall\n* `G003` (TrackedOutboundCorporateTransfer): Tracked Outbound Corporate Transfer.\n* `G004` (TrackedFinancialInstitutionTransfer): Tracked Financial Institution Transfer.\n* `NPCA` (NordicPaymentsCouncilAreaTransfer): Payments must be executed following the NPC Area Payment scheme.\n* `NUGP` (NonurgentPriorityPayment): Payment must be executed as a non-urgent transaction with priority settlement.\n* `NURG` (NonurgentPayment): Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction.\n* `PRPT` (EBAPriorityService): Transaction must be processed according to the EBA Priority Service.\n* `SDVA` (SameDayValue): Payment must be executed with same day value to the creditor.\n* `SEPA` (SingleEuroPaymentsArea): Payment must be executed following the Single Euro Payments Area scheme.\n* `SVDE` (DomesticChequeClearingAndSettlement): Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland.\n* `URGP` (UrgentPayment): Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.\n* `URNS` (UrgentPaymentNetSettlement): Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.\n* `INST` (InstantCreditTransferOrInstantDirectDebit): Used for payment initiation to identify that a Payment or Direct Debit initiation must be executed as an instant or real-time payment instrument.\n* `SRTP` (ServiceRequestToPay): Request to Pay (RTP) transaction refers to an RTP scheme (such as for example the SEPA Request to Pay (SRTP) scheme).\n* `SVAT` (ScheckVerarbeitungAustria): Scheck Verarbeitung Austria (Cheque Processing).\n* `G006` (TrackedCaseManagement): Specifies the service conditions applicable to a tracked exceptions and investigations case.\n* `G007` (TrackedInboundCustomerCreditTransfer): Specifies the service level for a tracked inbound customer credit transfer.\n* `G005` (TrackedInstantCustomerCreditTransfer): Tracked Instant Customer Credit Transfer.\n* `G009` (TrackedLowValueCrossBorderCustomerCreditTransfer): Specifies the service level for a tracked low-value cross-border customer credit transfer.\n* `WFSM` (WaitForSettlement): Transaction is to be treated as an advice and only applied to the account of the creditor or next agent after settlement of the cover has been confirmed.\n* `EOLO` (EuroOneLegOut): Payment is executed following a Euro One-Leg Out Scheme.\n* `SPLI` (SplitPayment): A split payment is a payment that is split into several payments of lower value, namely with the purpose to comply with maximum amount thresholds applicable to some domestic Payment Market Infrastructures or to reduce counterparty liquidity risk.\n","enum":["BKTR","G001","G002","G003","G004","NPCA","NUGP","NURG","PRPT","SDVA","SEPA","SVDE","URGP","URNS","INST","SRTP","SVAT","G006","G007","G005","G009","WFSM","EOLO","SPLI"],"type":"string"},"ServiceLevelCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"$ref":"#/components/schemas/ExternalServiceLevel1Code"}},"required":["schema","value"],"type":"object"},"ServiceLevel":{"discriminator":{"mapping":{"CODE":"#/components/schemas/ServiceLevelCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/ServiceLevelCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"PaymentTypeInformation":{"properties":{"categoryPurpose":{"$ref":"#/components/schemas/CategoryPurpose"},"localInstrument":{"$ref":"#/components/schemas/LocalInstrumentType"},"serviceLevel":{"items":{"$ref":"#/components/schemas/ServiceLevel"},"type":"array"}},"type":"object"},"PurposeTypeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `ACCT` : AccountManagement\n* `ADCS` : AdvisoryDonationCopyrightServices\n* `ADMG` : AdministrativeManagement\n* `ADVA` : AdvancePayment\n* `AEMP` : ActiveEmploymentPolicy\n* `AGRT` : AgriculturalTransfer\n* `AIRB` : Air\n* `ALLW` : Allowance\n* `ALMY` : AlimonyPayment\n* `AMEX` : Amex\n* `ANNI` : Annuity\n* `ANTS` : AnesthesiaServices\n* `AREN` : AccountsReceivablesEntry\n* `AUCO` : AuthenticatedCollections\n* `B112` : TrailerFeePayment\n* `BBSC` : BabyBonusScheme\n* `BCDM` : BearerChequeDomestic\n* `BCFG` : BearerChequeForeign\n* `BECH` : ChildBenefit\n* `BENE` : UnemploymentDisabilityBenefit\n* `BEXP` : BusinessExpenses\n* `BFWD` : BondForward\n* `BKDF` : BankLoanDelayedDrawFunding\n* `BKFE` : BankLoanFees\n* `BKFM` : BankLoanFundingMemo\n* `BKIP` : BankLoanAccruedInterestPayment\n* `BKPP` : BankLoanPrincipalPaydown\n* `BLDM` : BuildingMaintenance\n* `BNET` : BondForwardNetting\n* `BOCE` : BackOfficeConversionEntry\n* `BOND` : Bonds\n* `BONU` : BonusPayment.\n* `BR12` : TrailerFeeRebate\n* `BUSB` : Bus\n* `CABD` : CorporateActions-Bonds\n* `CAEQ` : CorporateActions-Equities\n* `CAFI` : CustodianManagementFeeInhouse\n* `CASH` : CashManagementTransfer\n* `CBCR` : CreditCard\n* `CBFF` : CapitalBuilding\n* `CBFR` : CapitalBuildingRetirement\n* `CBLK` : CardBulkClearing\n* `CBTV` : CableTVBill\n* `CCHD` : CashCompensationHelplessnessDisability\n* `CCIR` : CrossCurrencyIRS\n* `CCPC` : CCPClearedInitialMargin\n* `CCPM` : CCPClearedVariationMargin\n* `CCRD` : CreditCardPayment\n* `CCSM` : CCPClearedInitialMarginSegregatedCash\n* `CDBL` : CreditCardBill\n* `CDCB` : CardPaymentWithCashBack\n* `CDCD` : CashDisbursementCashSettlement\n* `CDCS` : CashDisbursementWithSurcharging\n* `CDDP` : CardDeferredPayment\n* `CDEP` : CreditDefaultEventPayment\n* `CDOC` : OriginalCredit\n* `CDQC` : QuasiCash\n* `CFDI` : CapitalFallingDueInhouse\n* `CFEE` : CancellationFee\n* `CGDD` : CardGeneratedDirectDebit\n* `CHAR` : CharityPayment\n* `CLPR` : CarLoanPrincipalRepayment\n* `CMDT` : CommodityTransfer\n* `COLL` : CollectionPayment\n* `COMC` : CommercialPayment\n* `COMM` : Commission\n* `COMP` : CompensationPayment\n* `COMT` : ConsumerThirdPartyConsolidatedPayment\n* `CORT` : TradeSettlementPayment\n* `COST` : Costs\n* `CPKC` : CarparkCharges\n* `CPYR` : Copyright\n* `CRDS` : CreditDefaultSwap\n* `CRPR` : CrossProduct\n* `CRSP` : CreditSupport\n* `CRTL` : CreditLine\n* `CSDB` : CashDisbursementCashManagement\n* `CSLP` : CompanySocialLoanPaymentToBank\n* `CVCF` : ConvalescentCareFacility\n* `DBCR` : DebitCard\n* `DBTC` : DebitCollectionPayment\n* `DCRD` : DebitCardPayment\n* `DEPT` : Deposit\n* `DERI` : Derivatives\n* `DICL` : Diners\n* `DIVD` : Dividend\n* `DMEQ` : DurableMedicaleEquipment\n* `DNTS` : DentalServices\n* `DSMT` : PrintedOrderDisbursement\n* `DVPM` : DeliverAgainstPayment\n* `ECPG` : GuaranteedEPayment\n* `ECPR` : EPaymentReturn\n* `ECPU` : NonGuaranteedEPayment\n* `EDUC` : Education\n* `EFTC` : LowValueCredit\n* `EFTD` : LowValueDebit\n* `ELEC` : ElectricityBill\n* `ENRG` : Energies\n* `EPAY` : Epayment\n* `EQPT` : EquityOption\n* `EQTS` : Equities\n* `EQUS` : EquitySwap\n* `ESTX` : EstateTax\n* `ETUP` : EPurseTopUp\n* `EXPT` : ExoticOption\n* `EXTD` : ExchangeTradedDerivatives\n* `FACT` : FactorUpdateRelatedPayment\n* `FAND` : FinancialAidInCaseOfNaturalDisaster\n* `FCOL` : FeeCollection\n* `FCPM` : LatePaymentOfFeesAndCharges\n* `FEES` : PaymentOfFees\n* `FERB` : Ferry\n* `FIXI` : FixedIncome\n* `FLCR` : FleetCard\n* `FNET` : FuturesNettingPayment\n* `FORW` : ForwardForeignExchange\n* `FREX` : ForeignExchange\n* `FUTR` : Futures\n* `FWBC` : ForwardBrokerOwnedCashCollateral\n* `FWCC` : ForwardClientOwnedCashCollateral\n* `FWLV` : ForeignWorkerLevy\n* `FWSB` : ForwardBrokerOwnedCashCollateralSegregated\n* `FWSC` : ForwardClientOwnedSegregatedCashCollateral\n* `FXNT` : ForeignExchangeRelatedNetting\n* `GAFA` : GovernmentFamilyAllowance\n* `GAHO` : GovernmentHousingAllowance\n* `GAMB` : GamblingOrWageringPayment\n* `GASB` : GasBill\n* `GDDS` : PurchaseSaleOfGoods\n* `GDSV` : PurchaseSaleOfGoodsAndServices\n* `GFRP` : GuaranteeFundRightsPayment\n* `GIFT` : Gift\n* `GOVI` : GovernmentInsurance\n* `GOVT` : GovernmentPayment\n* `GSCB` : PurchaseSaleOfGoodsAndServicesWithCashBack\n* `GSTX` : GoodsServicesTax\n* `GVEA` : AustrianGovernmentEmployeesCategoryA\n* `GVEB` : AustrianGovernmentEmployeesCategoryB\n* `GVEC` : AustrianGovernmentEmployeesCategoryC\n* `GVED` : AustrianGovernmentEmployeesCategoryD\n* `GWLT` : GovermentWarLegislationTransfer\n* `HEDG` : Hedging\n* `HLRP` : PropertyLoanRepayment\n* `HLST` : PropertyLoanSettlement\n* `HLTC` : HomeHealthCare\n* `HLTI` : HealthInsurance\n* `HREC` : HousingRelatedContribution\n* `HSPC` : HospitalCare\n* `HSTX` : HousingTax\n* `ICCP` : IrrevocableCreditCardPayment\n* `ICRF` : IntermediateCareFacility\n* `IDCP` : IrrevocableDebitCardPayment\n* `IHRP` : InstalmentHirePurchaseAgreement\n* `INPC` : InsurancePremiumCar\n* `INPR` : InsurancePremiumRefund\n* `INSC` : PaymentOfInsuranceClaim\n* `INSM` : Installment\n* `INSU` : InsurancePremium\n* `INTC` : IntraCompanyPayment\n* `INTE` : Interest\n* `INTP` : IntraPartyPayment\n* `INTX` : IncomeTax\n* `INVS` : InvestmentAndSecurities\n* `IPAY` : InstantPayments\n* `IPCA` : InstantPaymentsCancellation\n* `IPDO` : InstantPaymentsForDonations\n* `IPEA` : InstantPaymentsInECommerceWithoutAddressData\n* `IPEC` : InstantPaymentsInECommerceWithAddressData\n* `IPEW` : InstantPaymentsInECommerce\n* `IPPS` : InstantPaymentsAtPOS\n* `IPRT` : InstantPaymentsReturn\n* `IPU2` : InstantPaymentsUnattendedVendingMachineWith2FA\n* `IPUW` : InstantPaymentsUnattendedVendingMachineWithout2FA\n* `IVPT` : InvoicePayment\n* `LBIN` : LendingBuyInNetting\n* `LBRI` : LaborInsurance\n* `LCOL` : LendingCashCollateralFreeMovement\n* `LFEE` : LendingFees\n* `LICF` : LicenseFee\n* `LIFI` : LifeInsurance\n* `LIMA` : LiquidityManagement\n* `LMEQ` : LendingEquityMarkedToMarketCashCollateral\n* `LMFI` : LendingFixedIncomeMarkedToMarketCashCollateral\n* `LMRK` : LendingUnspecifiedTypeOfMarkedToMarketCashCollateral\n* `LOAN` : Loan\n* `LOAR` : LoanRepayment\n* `LOTT` : LotteryPayment\n* `LREB` : LendingRebatePayments\n* `LREV` : LendingRevenuePayments\n* `LSFL` : LendingClaimPayment\n* `LTCF` : LongTermCareFacility\n* `MAFC` : MedicalAidFundContribution\n* `MARF` : MedicalAidRefund\n* `MARG` : DailyMarginOnListedDerivatives\n* `MBSB` : MBSBrokerOwnedCashCollateral\n* `MBSC` : MBSClientOwnedCashCollateral\n* `MCDM` : MultiCurrenyChequeDomestic\n* `MCFG` : MultiCurrenyChequeForeign\n* `MDCS` : MedicalServices\n* `MGCC` : FuturesInitialMargin\n* `MGSC` : FuturesInitialMarginClientOwnedSegregatedCashCollateral\n* `MOMA` : MoneyMarket\n* `MP2B` : MobileP2BPayment\n* `MP2P` : MobileP2PPayment\n* `MSVC` : MultipleServiceTypes\n* `MTUP` : MobileTopUp\n* `NETT` : Netting\n* `NITX` : NetIncomeTax\n* `NOWS` : NotOtherwiseSpecified\n* `NWCH` : NetworkCharge\n* `NWCM` : NetworkCommunication\n* `OCCC` : ClientOwnedOCCPledgedCollateral\n* `OCDM` : OrderChequeDomestic\n* `OCFG` : OrderChequeForeign\n* `OFEE` : OpeningFee\n* `OPBC` : OTCOptionBrokerOwnedCashCollateral\n* `OPCC` : OTCOptionClientOwnedCashCollateral\n* `OPSB` : OTCOptionBrokerOwnedSegregatedCashCollateral\n* `OPSC` : OTCOptionClientOwnedCashSegregatedCashCollateral\n* `OPTN` : FXOption\n* `OTCD` : OTCDerivatives\n* `OTHR` : Other\n* `OTLC` : OtherTelecomRelatedBill\n* `PADD` : PreauthorizedDebit\n* `PAYR` : Payroll\n* `PCOM` : PropertyCompletionPayment\n* `PDEP` : PropertyDeposit\n* `PEFC` : PensionFundContribution\n* `PENO` : PaymentBasedOnEnforcementOrder\n* `PENS` : PensionPayment\n* `PHON` : TelephoneBill\n* `PLDS` : PropertyLoanDisbursement\n* `PLRF` : PropertyLoanRefinancing\n* `POPE` : PointOfPurchaseEntry\n* `PPTI` : PropertyInsurance\n* `PRCP` : PricePayment\n* `PRME` : PreciousMetal\n* `PTSP` : PaymentTerms\n* `PTXP` : PropertyTax\n* `RAPI` : RapidPaymentInstruction\n* `RCKE` : RepresentedCheckEntry\n* `RCPT` : ReceiptPayment\n* `RDTX` : RoadTax\n* `REBT` : Rebate\n* `REFU` : Refund\n* `RELG` : RentalLeaseGeneral\n* `RENT` : Rent\n* `REOD` : AccountOverdraftRepayment\n* `REPO` : RepurchaseAgreement\n* `RHBS` : RehabilitationSupport\n* `RIMB` : ReimbursementOfAPreviousErroneousTransaction\n* `RINP` : RecurringInstallmentPayment\n* `RLWY` : Railway\n* `ROYA` : Royalties\n* `RPBC` : BilateralRepoBrokerOwnedCollateral\n* `RPCC` : RepoClientOwnedCollateral\n* `RPNT` : BilateralRepoInternetNetting\n* `RPSB` : BilateralRepoBrokerOwnedSegregatedCashCollateral\n* `RPSC` : BilateralRepoClientOwnedSegregatedCashCollateral\n* `RRBN` : RoundRobin\n* `RRCT` : ReimbursementReceivedCreditTransfer\n* `RRTP` : RelatedRequestToPay\n* `RVPM` : ReceiveAgainstPayment\n* `RVPO` : ReverseRepurchaseAgreement\n* `SALA` : SalaryPayment\n* `SASW` : ATM\n* `SAVG` : Savings\n* `SBSC` : SecuritiesBuySellSellBuyBack\n* `SCIE` : SingleCurrencyIRSExotic\n* `SCIR` : SingleCurrencyIRS\n* `SCRP` : SecuritiesCrossProducts\n* `SCVE` : PurchaseSaleOfServices\n* `SECU` : Securities\n* `SEPI` : SecuritiesPurchaseInhouse\n* `SERV` : ServiceCharges\n* `SHBC` : BrokerOwnedCollateralShortSale\n* `SHCC` : ClientOwnedCollateralShortSale\n* `SHSL` : ShortSell\n* `SLEB` : SecuritiesLendingAndBorrowing\n* `SLOA` : SecuredLoan\n* `SLPI` : PaymentSlipInstruction\n* `SPLT` : SplitPayments\n* `SPSP` : SalaryPensionSumPayment\n* `SSBE` : SocialSecurityBenefit\n* `STDY` : Study\n* `SUBS` : Subscription\n* `SUPP` : SupplierPayment\n* `SWBC` : SwapBrokerOwnedCashCollateral\n* `SWCC` : SwapClientOwnedCashCollateral\n* `SWFP` : SwapContractFinalPayment\n* `SWPP` : SwapContractPartialPayment\n* `SWPT` : Swaption\n* `SWRS` : SwapContractResetPayment\n* `SWSB` : SwapsBrokerOwnedSegregatedCashCollateral\n* `SWSC` : SwapsClientOwnedSegregatedCashCollateral\n* `SWUF` : SwapContractUpfrontPayment\n* `TAXR` : TaxRefund\n* `TAXS` : TaxPayment\n* `TBAN` : TBAPairOffNetting\n* `TBAS` : ToBeAnnounced\n* `TBBC` : TBABrokerOwnedCashCollateral\n* `TBCC` : TBAClientOwnedCashCollateral\n* `TBIL` : TelecommunicationsBill\n* `TCSC` : TownCouncilServiceCharges\n* `TELI` : TelephoneInitiatedTransaction\n* `TLRF` : NonUSMutualFundTrailerFeePayment\n* `TLRR` : NonUSMutualFundTrailerFeeRebatePayment\n* `TMPG` : TMPGClaimPayment\n* `TPRI` : TriPartyRepoInterest\n* `TPRP` : TriPartyRepoNetting\n* `TRAD` : Commercial\n* `TRCP` : TreasuryCrossProduct\n* `TREA` : TreasuryPayment\n* `TRFD` : TrustFund\n* `TRNC` : TruncatedPaymentSlip\n* `TRPT` : RoadPricing\n* `TRVC` : TravellerCheque\n* `UBIL` : Utilities\n* `UNIT` : UnitTrustPurchase\n* `VATX` : ValueAddedTaxPayment\n* `VIEW` : VisionCare\n* `WEBI` : InternetInitiatedTransaction\n* `WHLD` : WithHolding\n* `WTER` : WaterBill\n","enum":["BKDF","BKFE","BKFM","BKIP","BKPP","CBLK","CDCB","CDCD","CDCS","CDDP","CDOC","CDQC","ETUP","FCOL","MTUP","ACCT","CASH","COLL","CSDB","DEPT","INTC","INTP","LIMA","NETT","BFWD","CCIR","CCPC","CCPM","CCSM","CRDS","CRPR","CRSP","CRTL","EQPT","EQUS","EXPT","EXTD","FIXI","FWBC","FWCC","FWSB","FWSC","MARG","MBSB","MBSC","MGCC","MGSC","OCCC","OPBC","OPCC","OPSB","OPSC","OPTN","OTCD","REPO","RPBC","RPCC","RPSB","RPSC","RVPO","SBSC","SCIE","SCIR","SCRP","SHBC","SHCC","SHSL","SLEB","SLOA","SWBC","SWCC","SWPT","SWSB","SWSC","TBAS","TBBC","TBCC","TRCP","AGRT","AREN","BEXP","BOCE","COMC","CPYR","GDDS","GDSV","GSCB","LICF","MP2B","POPE","ROYA","SCVE","SERV","SUBS","SUPP","TRAD","CHAR","COMT","MP2P","ECPG","ECPR","ECPU","EPAY","CLPR","COMP","DBTC","GOVI","HLRP","HLST","INPC","INPR","INSC","INSU","INTE","LBRI","LIFI","LOAN","LOAR","PENO","PPTI","RELG","RINP","TRFD","FORW","FXNT","ADMG","ADVA","BCDM","BCFG","BLDM","BNET","CBFF","CBFR","CCRD","CDBL","CFEE","CGDD","CORT","COST","CPKC","DCRD","DSMT","DVPM","EDUC","FACT","FAND","FCPM","FEES","GIFT","GOVT","ICCP","IDCP","IHRP","INSM","IVPT","MCDM","MCFG","MSVC","NOWS","OCDM","OCFG","OFEE","OTHR","PADD","PTSP","RCKE","RCPT","REBT","REFU","RENT","REOD","RIMB","RPNT","RRBN","RRCT","RRTP","RVPM","SLPI","SPLT","STDY","TBAN","TBIL","TCSC","TELI","TMPG","TPRI","TPRP","TRNC","TRVC","WEBI","IPAY","IPCA","IPDO","IPEA","IPEC","IPEW","IPPS","IPRT","IPU2","IPUW","ANNI","CAFI","CFDI","CMDT","DERI","DIVD","FREX","HEDG","INVS","PRME","SAVG","SECU","SEPI","TREA","UNIT","FNET","FUTR","ANTS","CVCF","DMEQ","DNTS","HLTC","HLTI","HSPC","ICRF","LTCF","MAFC","MARF","MDCS","VIEW","CDEP","SWFP","SWPP","SWRS","SWUF","ADCS","AEMP","ALLW","ALMY","BBSC","BECH","BENE","BONU","CCHD","COMM","CSLP","GFRP","GVEA","GVEB","GVEC","GVED","GWLT","HREC","PAYR","PEFC","PENS","PRCP","RHBS","SALA","SPSP","SSBE","LBIN","LCOL","LFEE","LMEQ","LMFI","LMRK","LREB","LREV","LSFL","ESTX","FWLV","GSTX","HSTX","INTX","NITX","PTXP","RDTX","TAXS","VATX","WHLD","TAXR","B112","BR12","TLRF","TLRR","AIRB","BUSB","FERB","RLWY","TRPT","CBTV","ELEC","ENRG","GASB","NWCH","NWCM","OTLC","PHON","UBIL","WTER","BOND","CABD","CAEQ","CBCR","DBCR","DICL","EQTS","FLCR","EFTC","EFTD","MOMA","RAPI","GAMB","LOTT","GAFA","GAHO","AMEX","SASW","AUCO","PCOM","PDEP","PLDS","PLRF"],"type":"string"}},"required":["value","schema"],"type":"object"},"PurposeType":{"description":"Specifies the underlying reason for the payment transaction","discriminator":{"mapping":{"CODE":"#/components/schemas/PurposeTypeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PurposeTypeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"CreditorReferenceType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/CreditorReferenceTypeCode","PROPRIETARY":"#/components/schemas/CreditorReferenceTypeProprietary"},"propertyName":"schema"},"properties":{"issuer":{"description":"Entity that assigns the credit reference type","maxLength":35,"type":"string"},"schema":{"description":"Identifies the value as being either proprietary (`PROPRIETARY`) or as being a pre-defined code (`CODE`).\n","enum":["CODE","PROPRIETARY"],"type":"string"}},"required":["schema"],"type":"object"},"CreditorReferenceTypeCode":{"allOf":[{"$ref":"#/components/schemas/CreditorReferenceType"},{"description":"Specifies the type of creditor reference.","properties":{"value":{"description":"* `RADM` (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.\n* `RPIN` (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.\n* `FXDR` (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.\n* `DISP` (DispatchAdvice): Document is a dispatch advice.\n* `PUOR` (PurchaseOrder): Document is a purchase order.\n* `SCOR` (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.\n","enum":["RADM","RPIN","FXDR","DISP","PUOR","SCOR"],"type":"string"}},"required":["value"],"type":"object"}],"type":"object"},"CreditorReferenceTypeProprietary":{"allOf":[{"$ref":"#/components/schemas/CreditorReferenceType"},{"properties":{"value":{"$ref":"#/components/schemas/ProprietaryValueLiteral"}},"required":["value"],"type":"object"}],"type":"object"},"CreditorReference":{"properties":{"reference":{"description":"Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.","maxLength":35,"type":"string"},"type":{"$ref":"#/components/schemas/CreditorReferenceType"}},"type":"object"},"ContactDetails":{"properties":{"emailAddress":{"format":"email","type":"string"},"mobileNumber":{"$ref":"#/components/schemas/PhoneNumber"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}},"type":"object"},"OrganisationIdentifierBic":{"description":"An organisation identified by a code allocated to a financial or non-financial institution by the ISO 9362\nRegistration Authority, as described in ISO 9362: 2014 - Banking - Banking telecommunication messages -\nBusiness identifier code (BIC).\n","properties":{"BIC":{"pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}","type":"string"},"schema":{"description":"Indicates the identifier as a BIC organisation identifier, always `BIC`","type":"string"}},"required":["BIC","schema"],"type":"object"},"OrganisationIdentifierLei":{"description":"An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services -\nLegal Entity Identifier (LEI).\n","properties":{"LEI":{"pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"schema":{"description":"Indicates the identifier as a LEI organisation identifier, always `LEI`","type":"string"}},"required":["LEI","schema"],"type":"object"},"OrganisationIdentificationCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `BANK` : BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.\n* `CBID` : CentralBankIdentificationNumber. A unique identification number assigned by a central bank to identify an organisation.\n* `CHID` : ClearingIdentificationNumber. A unique identification number assigned by a clearing house to identify an organisation\n* `CINC` : CertificateOfIncorporationNumber. A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.\n* `COID` : CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)\n* `CUST` : CustomerNumber. Number assigned by an issuer to identify a customer or number assigned by a party to identify a creditor or debtor relationship.\n* `DUNS` : DataUniversalNumberingSystem. A unique identification number provided by Dun & Bradstreet to identify an organisation.\n* `EMPL` : EmployerIdentificationNumber. Number assigned by a registration authority to an employer.\n* `GS1G` : GS1GLNIdentifier. Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.\n* `SREN` : SIREN. The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n* `SRET` : SIRET. The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity\n* `TXID` : TaxIdentificationNumber. Number assigned by a tax authority to identify an organisation.\n* `BDID` : BusinessDomainIdentifier. Identifier of the business domain in which the organisation is active.\n* `BOID` : BusinessOtherIdentification. Other identification of the organisation.\n","enum":["BANK","CBID","CHID","CINC","COID","CUST","DUNS","EMPL","GS1G","SREN","SRET","TXID","BDID","BOID"],"type":"string"}},"required":["value","schema"],"type":"object"},"OrganisationIdentifierScheme":{"discriminator":{"mapping":{"CODE":"#/components/schemas/OrganisationIdentificationCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/OrganisationIdentificationCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"OrganisationIdentifierOther":{"description":"A unique identification of an organisation, as assigned by an institution, using an identification scheme.\n","properties":{"identification":{"maxLength":35,"type":"string"},"issuer":{"description":"The name of the entity that assigns the identification","maxLength":35,"type":"string"},"schema":{"description":"Indicates the identifier as a unique identification of an organisation, as assigned by an institution. Always `OTHER`","type":"string"},"scheme":{"$ref":"#/components/schemas/OrganisationIdentifierScheme"}},"required":["identification","schema"],"type":"object"},"OrganisationIdentifier":{"description":"Holds identification details for an organisation.","discriminator":{"mapping":{"BIC":"#/components/schemas/OrganisationIdentifierBic","LEI":"#/components/schemas/OrganisationIdentifierLei","OTHER":"#/components/schemas/OrganisationIdentifierOther"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/OrganisationIdentifierBic"},{"$ref":"#/components/schemas/OrganisationIdentifierLei"},{"$ref":"#/components/schemas/OrganisationIdentifierOther"}],"type":"object"},"OrganisationIdentification":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/OrganisationIdentifier"},"type":"array"},"schema":{"description":"Identifies the party as an organisation, always `ORGANISATION`","type":"string"}},"required":["identifiers","schema"],"type":"object"},"PersonIdentificationCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `ARNU`: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.\n* `CCPT`: PassportNumber. A number assigned by an authority to identify the passport number of a person.\n* `CUST`: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.\n* `DRLC`: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.\n* `EMPL`: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.\n* `NIDN`: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.\n* `SOSE`: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.\n* `TELE`: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.\n* `TXID`: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.\n* `POID`: PersonOtherIdentification. Other identification of the person.\n","enum":["ARNU","CCPT","CUST","DRLC","EMPL","NIDN","SOSE","TELE","TXID","POID"],"type":"string"}},"required":["value","schema"],"type":"object"},"PersonIdentifierScheme":{"discriminator":{"mapping":{"CODE":"#/components/schemas/PersonIdentificationCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PersonIdentificationCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"PersonIdentifier":{"properties":{"identification":{"description":"Unique and unambiguous identification of a person, for example a passport.\n","maxLength":35,"type":"string"},"issuer":{"description":"The entity that assigns the identification","maxLength":35,"type":"string"},"scheme":{"$ref":"#/components/schemas/PersonIdentifierScheme"}},"required":["identification"],"type":"object"},"PersonIdentification":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/PersonIdentifier"},"type":"array"},"schema":{"description":"Identifies the party as a person, always `PERSON`\n","type":"string"}},"required":["identifiers","schema"],"type":"object"},"PartyIdentification":{"description":"The identification of a party, either a person or an organisation.\n","discriminator":{"mapping":{"ORGANISATION":"#/components/schemas/OrganisationIdentification","PERSON":"#/components/schemas/PersonIdentification"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/PersonIdentification"},{"$ref":"#/components/schemas/OrganisationIdentification"}],"type":"object"},"Party":{"description":"This model is the basic representation of a Party. It is expanded on depending on whether the party is a person\nor an organisation.\n","properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"contactDetails":{"$ref":"#/components/schemas/ContactDetails"},"countryOfResidence":{"$ref":"#/components/schemas/CountryCode"},"identification":{"$ref":"#/components/schemas/PartyIdentification"},"knownAsName":{"description":"The name by which this party is commonly known in day to day use. For example, a shortening of their legal\nname or a nickname that they commonly use. This is \"non-official\". However, it is acceptable for this field\nto be set to the same as `legalName`.\n","maxLength":140,"minLength":1,"type":"string"},"legalName":{"description":"The legal name by which this party is known (the \"FICA\" name). This is the full name of the party\nas found on country-issued documentation (national identity, company registration documentation etc).\n","maxLength":140,"minLength":1,"type":"string"}},"type":"object"},"ReferredDocumentAmount":{"properties":{"duePayableAmount":{"$ref":"#/components/schemas/Amount","description":"Amount specified is the exact amount due and payable to the creditor."},"remittedAmount":{"$ref":"#/components/schemas/Amount","description":"Amount of money remitted for the referred document."}},"type":"object"},"ReferredDocumentType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/ReferredDocumentTypeCode","PROPRIETARY":"#/components/schemas/ReferredDocumentTypeProprietary"},"propertyName":"schema"},"properties":{"issuer":{"description":"Identification of the issuer of the reference document _type_.","maxLength":35,"type":"string"},"schema":{"description":"Identifies the value as being either proprietary (`PROPRIETARY`) or as being a pre-defined code (`CODE`).\n","enum":["CODE","PROPRIETARY"],"type":"string"}},"required":["schema"],"type":"object"},"ReferredDocumentTypeCode":{"allOf":[{"$ref":"#/components/schemas/ReferredDocumentType"},{"description":"Specifies the type of referred document","properties":{"value":{"description":"* `AROI` : AccountReceivableOpenItem\n* `BOLD` : BillOfLading\n* `CINV` : CommercialInvoice\n* `CMCN` : CommercialContract\n* `CNFA` : CreditNoteRelatedToFinancialAdjustment\n* `CREN` : CreditNote\n* `DEBN` : DebitNote\n* `DISP` : DispatchAdvice\n* `DNFA` : DebitNoteRelatedToFinancialAdjustment\n* `HIRI` : HireInvoice\n* `MSIN` : MeteredServiceInvoice\n* `PUOR` : PurchaseOrder\n* `SBIN` : SelfBilledInvoice\n* `SOAC` : StatementOfAccount\n* `TSUT` : TradeServicesUtilityTransaction\n* `VCHR` : Voucher\n","enum":["AROI","BOLD","CINV","CMCN","CNFA","CREN","DEBN","DISP","DNFA","HIRI","MSIN","PUOR","SBIN","SOAC","TSUT","VCHR"],"type":"string"}},"required":["value"],"type":"object"}],"type":"object"},"ReferredDocumentTypeProprietary":{"allOf":[{"$ref":"#/components/schemas/ReferredDocumentType"},{"properties":{"value":{"$ref":"#/components/schemas/ProprietaryValueLiteral"}},"required":["value"],"type":"object"}],"type":"object"},"ReferredDocument":{"properties":{"documentIdentifier":{"description":"Unique and unambiguous identification of the referred document.","maxLength":35,"type":"string"},"relatedDate":{"description":"The date associated with the referred document.","format":"date","type":"string"},"type":{"$ref":"#/components/schemas/ReferredDocumentType"}},"type":"object"},"TaxParty":{"properties":{"registrationIdentification":{"description":"Unique identification, as assigned by an organisation, to unambiguously identify a party","maxLength":35,"minLength":1,"type":"string"},"taxIdentification":{"description":"Tax identification number","maxLength":35,"minLength":1,"type":"string"},"taxType":{"description":"Type of tax payer.","maxLength":35,"minLength":1,"type":"string"}},"type":"object"},"TaxAuthorisation":{"properties":{"name":{"description":"Name of the tax payer or tax payer's authorised representative","maxLength":140,"minLength":1,"type":"string"},"title":{"description":"Title or position of the tax payer or tax payer's authorised representative","maxLength":35,"minLength":1,"type":"string"}},"type":"object"},"AuthorisedTaxParty":{"allOf":[{"$ref":"#/components/schemas/TaxParty"},{"properties":{"authorisation":{"$ref":"#/components/schemas/TaxAuthorisation"}},"type":"object"}]},"TaxRemittance":{"properties":{"creditor":{"$ref":"#/components/schemas/TaxParty"},"date":{"description":"Date by which tax is due","format":"date","type":"string"},"debtor":{"$ref":"#/components/schemas/AuthorisedTaxParty"},"referenceNumber":{"description":"Tax reference information that is specific to a taxing agency.","maxLength":140,"minLength":1,"type":"string"},"sequenceNumber":{"description":"Sequential number of the tax report.","format":"int64","type":"integer"},"totalTaxAmount":{"$ref":"#/components/schemas/Amount"},"totalTaxableBaseAmount":{"$ref":"#/components/schemas/Amount"},"ultimateDebtor":{"$ref":"#/components/schemas/AuthorisedTaxParty"}},"type":"object"},"StructuredRemittanceInformation":{"properties":{"additionalRemittanceInformation":{"items":{"maxLength":140,"type":"string"},"maxItems":3,"type":"array"},"creditorReference":{"$ref":"#/components/schemas/CreditorReference"},"invoicer":{"$ref":"#/components/schemas/Party"},"originatorReference":{"description":"An explanation of the transaction, this field may be used to capture the information which may then be displayed on the payment originator's bank statement (ie. the debtor for a credit transfer or the creditor for a direct debit). This field is not supported by all Electrum partner implementations, and will be ignored if provided in an unsupported use-case.","maxLength":35,"type":"string"},"referredDocumentAmount":{"$ref":"#/components/schemas/ReferredDocumentAmount"},"referredDocuments":{"items":{"$ref":"#/components/schemas/ReferredDocument"},"type":"array"},"taxRemittance":{"$ref":"#/components/schemas/TaxRemittance"}},"type":"object"},"RemittanceInformation":{"properties":{"structured":{"items":{"$ref":"#/components/schemas/StructuredRemittanceInformation"},"type":"array"},"unstructured":{"items":{"maxLength":140,"type":"string"},"type":"array"}},"type":"object"},"BaseOriginalTransactionData":{"properties":{"amounts":{"$ref":"#/components/schemas/TransactionAmounts"},"creditorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"creditorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"creditorAgentAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"debtorAgentAccount":{"$ref":"#/components/schemas/PaymentAccount"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod","description":"Specifies the means of payment for the original transaction.\n"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation"},"purpose":{"$ref":"#/components/schemas/PurposeType"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation"},"settlementDate":{"description":"Date on which the amount of money ceases to be available to the agent that owes it and when the amount of\nmoney becomes available to the agent to which it is due.\n","format":"date","type":"string"},"supplementaryData":{"$ref":"#/components/schemas/SupplementaryData"}},"type":"object"},"OriginalTransactionData":{"allOf":[{"$ref":"#/components/schemas/BaseOriginalTransactionData"},{"properties":{"creditor":{"$ref":"#/components/schemas/Party"},"debtor":{"$ref":"#/components/schemas/Party"},"initiatingParty":{"$ref":"#/components/schemas/Party"}},"type":"object"}],"description":"Contains key elements related to the original transaction that is being referred to.\n"},"CbprPlusPaymentStatusReportPaymentScheme":{"properties":{"schema":{"type":"string"}},"required":["schema"],"type":"object"},"ZaEftPaymentStatusReportPaymentScheme":{"properties":{"schema":{"$ref":"#/components/schemas/PaymentSchemeName"}},"required":["schema"],"type":"object"},"ZaRppPaymentStatusReportPaymentScheme":{"properties":{"schema":{"$ref":"#/components/schemas/PaymentSchemeName"}},"required":["schema"],"type":"object"},"ZaRtcCreditTransferPaymentSchemeData":{"properties":{"businessReference":{"description":"Business reference number. The first two numeric digits identify the bank and the last 8\ncharacters contain a unique alphanumeric value generated by the originating bank (unique for the\ntransaction).\n","maxLength":10,"pattern":"^\\d{2}[\\dA-z]{8}$","type":"string"},"originatorEchoData":{"description":"Echo data reserved for originator use. Must remain unaltered by the beneficiary.","maxLength":20,"pattern":"^[\\dA-z ]*$","type":"string"},"userReference":{"description":"An explanation of the transaction, e.g. to be printed on the account holder's statement.\n","maxLength":20,"pattern":"^[\\dA-z ]*$","type":"string"}},"required":["businessReference"],"type":"object"},"ZaRtcPaymentStatusReportPaymentSchemeData":{"properties":{"authorisationId":{"description":"A unique number assigned by the beneficiary bank to identify the transaction if it is approved.\nMust remain unaltered by the originator.\n","maxLength":6,"pattern":"^[\\dA-z ]*$","type":"string"},"beneficiaryEchoData":{"description":"Echo data reserved for beneficiary use. Must remain unaltered by the originator.","maxLength":20,"pattern":"^[\\dA-z ]*$","type":"string"}},"type":"object"},"ZaRtcPaymentStatusReportPaymentScheme":{"properties":{"originalSchemeData":{"$ref":"#/components/schemas/ZaRtcCreditTransferPaymentSchemeData"},"schema":{"$ref":"#/components/schemas/PaymentSchemeName"},"schemeData":{"$ref":"#/components/schemas/ZaRtcPaymentStatusReportPaymentSchemeData"}},"required":["schema","originalSchemeData","schemeData"],"type":"object"},"PaymentStatusReportPaymentScheme":{"description":"Designates which scheme a payment status report is associated with and describes scheme-specific information\nfor the payment status report.\n","discriminator":{"mapping":{"CBPR_PLUS":"#/components/schemas/CbprPlusPaymentStatusReportPaymentScheme","ZA_EFT":"#/components/schemas/ZaEftPaymentStatusReportPaymentScheme","ZA_RPP":"#/components/schemas/ZaRppPaymentStatusReportPaymentScheme","ZA_RTC":"#/components/schemas/ZaRtcPaymentStatusReportPaymentScheme"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/ZaRtcPaymentStatusReportPaymentScheme"},{"$ref":"#/components/schemas/ZaRppPaymentStatusReportPaymentScheme"},{"$ref":"#/components/schemas/ZaEftPaymentStatusReportPaymentScheme"},{"$ref":"#/components/schemas/CbprPlusPaymentStatusReportPaymentScheme"}],"type":"object"},"PaymentStatusReport":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusReport"},{"properties":{"mandateInformation":{"$ref":"#/components/schemas/MandateInformation","description":"Provides details of the direct debit mandate signed between the creditor and the debtor.\n"},"originalTransactionData":{"$ref":"#/components/schemas/OriginalTransactionData"},"paymentScheme":{"$ref":"#/components/schemas/PaymentStatusReportPaymentScheme"},"schema":{"enum":["PaymentStatusReport"],"type":"string"}},"required":["paymentScheme","schema"],"type":"object"}],"description":"This message is used to report information about the positive or negative status of a FI to FI customer payment \ninstruction, or to report on a pending FI to FI customer instruction.\n\nThe fields `instructingAgent`, `instructedAgent` and `originalTransactionData` are not mandatory, but will\nalways be populated in payment status reports sent by Electrum.\n"}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example"]},{"$$mdtype":"Tag","name":"openapiexample","attributes":{"definitionid":"bpp-partner","pointer":"#/components/examples/PaymentStatusReportSuccessExample"},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-openapi/epc-cicd/epc-elpapi-partner-redoc.yaml","operationId":"inboundCreditTransferCompletion","exampleKey":"RTC_APPROVED","language":"Payload","parameters":{},"options":{},"environments":{}},"children":[]}]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You respond with an acknowledgement (ACK) in the form of an HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]}," status code with no additional content."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-handling-1"},"children":["Error Handling"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"no-response-from-corporate-client"},"children":["No Response from Corporate Client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/epc-payshap-inbound-no-response-cc.1b0ed4abe3ef56438f564858eb53b0ba29b825a1766cdc8b7589cabc1e58909b.9c1bb791.svg","alt":"bpp inbound payshap no response from BP"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum treats the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," as a must-deliver message and will repeatedly send it to you via a store-and-forward (SAF) queue until you acknowledge receipt with an HTTP response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your solution includes the use of Electrum Finance for transaction reconciliation and Electrum does not receive an acknowledgement before the reconciliation window closes, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," transaction will be considered a reconciliation exception. The Electrum daily mark-off extract may contain a transaction which was not seen by your system, and subsequently was not included in your daily mark-off extract."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"IMPORTANT"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum sends an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," to you even if the inbound payment was unsuccessful. Refer to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status.outcome"]}," field to determine whether or not funds should be credited."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In rare circumstances, Electrum may be unable to determine the final state of the transaction from the payment network. In this case you will not receive an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," and no action is required from you. Any discrepancy between your view of the transaction and that of the sending participant will need to be resolved during reconciliation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"testing-your-implementation"},"children":["Testing Your Implementation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Follow the testing procedure described ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/epc/public/test-receive-payshap"},"children":["here"]}," to make sure you have implemented the functionality correctly."]}]},"headings":[{"value":"Receive PayShap with Auto-Auth","id":"receive-payshap-with-auto-auth","depth":1},{"value":"Proxy Resolution","id":"proxy-resolution","depth":2},{"value":"Duplicate or Multiple Proxy Resolution Requests","id":"duplicate-or-multiple-proxy-resolution-requests","depth":3},{"value":"Error Handling","id":"error-handling","depth":2},{"value":"Technical Error","id":"technical-error","depth":4},{"value":"Negative Outcome","id":"negative-outcome","depth":4},{"value":"Timeout","id":"timeout","depth":4},{"value":"Clearing","id":"clearing","depth":2},{"value":"Error Handling","id":"error-handling-1","depth":3},{"value":"No Response from Corporate Client","id":"no-response-from-corporate-client","depth":4},{"value":"Testing Your Implementation","id":"testing-your-implementation","depth":2}],"frontmatter":{"seo":{"title":"Receive PayShap with Auto-Auth"}},"lastModified":"2025-09-09T12:59:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/epc/public/payshap-auto-auth","userData":{"isAuthenticated":false,"teams":["anonymous"]}}