{"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":"Bulk RTP","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":"bulk-rtp"},"children":["Bulk RTP"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum offers corporate clients the ability to make multiple payment requests in one transaction. This solution supports only pay-by-proxy bulk RTP. The RTPs in the bulk may have different destinations (paying banks)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Even though the initial request is sent as a bulk, Electrum will then extract each RTP to be sent to its intended destination and be processed and cleared individually with industry."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As in the case of single RTP, all RTP statuses are stored in Electrum’s RTP Store. Electrum will check and update the RTP status in the store as the transaction progresses."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Any RTP declines or cancellations will be handled according to the single RTP flows (see below)."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rtp-acceptance"},"children":["RTP Acceptance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/bulk-rtp-accept.97a9b9cef7a9d81a81465e6d6077efee35b1586d4ed9877f61472a23b205bae1.586f3b22.svg","alt":"bulk rtp accept"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a bulk RTP request to Electrum using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPay"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-redoc/bulk/outboundbulkrequesttopay"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiation"]}," schema). For each bulk request you must generate a bulk ID and populate this value in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestToPayInformationId"]}," field. List the individual RTP requests as an array of objects in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestToPayInitiationInstructions"]}," field."]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["RequestToPayInitiation Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/RequestToPayInitiation"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/RequestToPayInitiation"},"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"},"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"},"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"},"PhoneNumber":{"pattern":"^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$","type":"string"},"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"},"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"},"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"},"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"},"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"},"BankingIdentifier":{"discriminator":{"mapping":{"GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"}],"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"},"CustomIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"maxLength":2048,"minLength":1,"type":"string"}},"required":["value"],"type":"object"}]},"MobileNumberIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}},"required":["value"],"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"RequestToPayConditions":{"description":"Describes the various aspects of a request to pay which must be\naccepted or to what extent they may be altered.\n","properties":{"maxAmount":{"$ref":"#/components/schemas/Amount","description":"The maximum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"},"minAmount":{"$ref":"#/components/schemas/Amount","description":"The minimum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"}},"required":["minAmount","maxAmount"],"type":"object"},"TaxInformation":{"properties":{"totalAmount":{"$ref":"#/components/schemas/Amount"}},"required":["totalAmount"],"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"},"RequestToPayInitiationInstruction":{"description":"Initiation instruction object. This is a striped down version of the requestToPay model with the fields that can be\ninferred from the bulk information removed.\n","properties":{"creditor":{"$ref":"#/components/schemas/Party"},"creditorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"creditorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"debtor":{"$ref":"#/components/schemas/Party"},"debtorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"expiryDateTime":{"description":"Date and time at which the request to pay expires. Some schemes\nmay still permit a payment after the request to pay expires. Upon\nexpiry, the following schemes will reject an associated payment: ZA_RPP.\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"},"instructionForDebtorAgent":{"description":"Further information related to the processing of the payment instruction, provided by the\ninitiating party, and intended for the debtor agent.\n","items":{"$ref":"#/components/schemas/CreditorAgentInstruction"},"minItems":0,"type":"array"},"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation"},"purpose":{"$ref":"#/components/schemas/PurposeType"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation"},"requestToPayConditions":{"$ref":"#/components/schemas/RequestToPayConditions"},"tax":{"$ref":"#/components/schemas/TaxInformation"},"transactionIdentifiers":{"$ref":"#/components/schemas/TransactionIdentifiers"}},"required":["messageIdentifiers","transactionIdentifiers","expiryDateTime","requestToPayConditions","creditor","creditorAccount","creditorAgent","debtorAccount","paymentTypeInformation","remittanceInformation"],"type":"object"},"RequestToPayInitiation":{"allOf":[{"description":"Object used to initiate a bulk of request to pay transactions. The transactions are defined in the `requestToPayInitiationInstructions`\narray. The bulk can only contain one payment scheme's transactions.\n"},{"$ref":"#/components/schemas/BaseMessage"},{"properties":{"bulkPaymentSchemeName":{"$ref":"#/components/schemas/PaymentSchemeName"},"initiatingParty":{"$ref":"#/components/schemas/Party"},"numberOfTransactions":{"description":"The total number of transactions in the bulk.","minimum":1,"type":"integer"},"requestToPayInformationId":{"description":"Universally unique identifier to identify the bulk collection itself.\n","format":"UUID","type":"string"},"requestToPayInitiationInstructions":{"description":"List of instructions to initiate each request to pay within the bulk with other financial institutions or the partner bank.","items":{"$ref":"#/components/schemas/RequestToPayInitiationInstruction"},"minItems":1,"type":"array"}},"required":["requestToPayInformationId","bulkPaymentSchemeName","requestToPayInitiationInstructions"],"type":"object"}]}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum checks that:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The number of RTPs in the bulk matches the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numberOfTransactions"]}," value that you have indicated in the request message."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The transaction amounts for each RTP are valid. (Note that any invalid RTPs will be deemed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}," and will not be processed further.)"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum debulks the request and sends each individual RTP to industry."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once all valid RTPs have reached their destination banks, Electrum will rebulk the individual RTPs and send a bulk response to you using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPayResponse"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/bulk/outboundbulkrequesttopayresponse"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiationResponse"]}," schema), showing the current status of the bulk."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From this point, the message flow follows a single RTP flow: The payer at the industry bank accepts the request-to-pay and the industry bank initiates the payment. BankservAfrica sends the credit transfer request to Electrum."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum retrieves the RTP status from the Store and determines that it is valid by:"]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Confirming the RTP exists and the status is either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},", and is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXPIRED"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID"]},". Note: the payment will still be accepted in the case that the RTP status is PENDING in the RTP store. For instance, in cases where the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundRequestToPayResponse"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},") message has gotten lost, or there was a timeout, or the payer paid very soon after receiving the RTP, before the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundRequestToPayResponse"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},") could reach the RTP store."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When amount modification is not allowed, checking that the amount sent by the payer matches that of the amount requested in the original request."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When amount modification is allowed, checking that the amount sent by the payer is within the maximum and minimum requested amount."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Confirming that the creditor account number or proxy and domain belong to a listed corporate client."]}]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":7},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your institution participates in partner-authorisation, this additional clearing authorisation step will occur: Electrum sends an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferAuthorisation"]}," request to you, and you acknowledge with an ACK HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},". You send Electrum a positive ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferAuthorisationResponse"]}," message when the validations pass, and Electrum returns a positive acknowledgement."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum sends an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inboundCreditTransferCompletion"]}," message (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentStatusReport"]}," schema) message to you to indicate clearing completion, and updates the RTP status to PAID."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["(Optional) You can query the status of the bulk itself by sending a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getOutboundBulkRequestToPayStatus"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-redoc/bulk/getoutboundbulkrequesttopaystatus"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiationStatusRequest"]}," schema). Electrum returns a bulk response to the corporate client, using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPayResponse"]}," operation (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiationResponse"]}," schema), showing the current status of each RTP in the bulk."]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum collates the information for all the paid RTPs and sends a posting instructing the sponsor bank to credit your account with the paid amount."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"RTP Status Requests"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can request the status of the bulk at any point by sending a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getOutboundBulkRequestToPayStatus"]}," message which must include the bulk reference ID, to Electrum. Set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeIndividualRequestToPayStatuses"]}," field to true or false:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If true: an aggregate of the bulk status as well as the status of each individual transaction within the bulk will be returned with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPayResponse"]}," response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If false: only an aggregate of the bulk status will be returned with the outboundBulkRequestToPayResponse."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The bulk status response will detail the number of transactions in each state: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXPIRED"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSUBMITTED"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can request the status of an individual RTP from the RTP Store at any time for any reason by sending a synchronous ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getRequestToPayWithPOST"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-redoc/request-to-pay/getrequesttopaywithpost"},"children":["request"]},", including the original RTP UETR, directly to the RTP Store."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will only receive the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPayResponse"]}," once all RTP transactions within the submitted bulk have received a response from industry. You will not receive an interim response unless you send a status request as described above."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rtp-decline"},"children":["RTP Decline"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/bulk-rtp-decline.b749c4ceb3d410145a5efc66a209830cd7f5352a6d36ec565fb471fe7d20a754.586f3b22.svg","alt":"bulk rtp decline"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a bulk RTP request to Electrum using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPay"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-redoc/bulk/outboundbulkrequesttopay"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiation"]}," schema). For each bulk request you must generate a bulk ID and populate this value in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestToPayInformationId"]}," field. List the individual RTP requests as an array of objects in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestToPayInitiationInstructions"]}," field."]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["RequestToPayInitiation Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/RequestToPayInitiation"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/RequestToPayInitiation"},"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"},"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"},"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"},"PhoneNumber":{"pattern":"^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$","type":"string"},"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"},"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"},"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"},"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"},"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"},"BankingIdentifier":{"discriminator":{"mapping":{"GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"}],"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"},"CustomIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"maxLength":2048,"minLength":1,"type":"string"}},"required":["value"],"type":"object"}]},"MobileNumberIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}},"required":["value"],"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"RequestToPayConditions":{"description":"Describes the various aspects of a request to pay which must be\naccepted or to what extent they may be altered.\n","properties":{"maxAmount":{"$ref":"#/components/schemas/Amount","description":"The maximum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"},"minAmount":{"$ref":"#/components/schemas/Amount","description":"The minimum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"}},"required":["minAmount","maxAmount"],"type":"object"},"TaxInformation":{"properties":{"totalAmount":{"$ref":"#/components/schemas/Amount"}},"required":["totalAmount"],"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"},"RequestToPayInitiationInstruction":{"description":"Initiation instruction object. This is a striped down version of the requestToPay model with the fields that can be\ninferred from the bulk information removed.\n","properties":{"creditor":{"$ref":"#/components/schemas/Party"},"creditorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"creditorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"debtor":{"$ref":"#/components/schemas/Party"},"debtorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"expiryDateTime":{"description":"Date and time at which the request to pay expires. Some schemes\nmay still permit a payment after the request to pay expires. Upon\nexpiry, the following schemes will reject an associated payment: ZA_RPP.\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"},"instructionForDebtorAgent":{"description":"Further information related to the processing of the payment instruction, provided by the\ninitiating party, and intended for the debtor agent.\n","items":{"$ref":"#/components/schemas/CreditorAgentInstruction"},"minItems":0,"type":"array"},"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation"},"purpose":{"$ref":"#/components/schemas/PurposeType"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation"},"requestToPayConditions":{"$ref":"#/components/schemas/RequestToPayConditions"},"tax":{"$ref":"#/components/schemas/TaxInformation"},"transactionIdentifiers":{"$ref":"#/components/schemas/TransactionIdentifiers"}},"required":["messageIdentifiers","transactionIdentifiers","expiryDateTime","requestToPayConditions","creditor","creditorAccount","creditorAgent","debtorAccount","paymentTypeInformation","remittanceInformation"],"type":"object"},"RequestToPayInitiation":{"allOf":[{"description":"Object used to initiate a bulk of request to pay transactions. The transactions are defined in the `requestToPayInitiationInstructions`\narray. The bulk can only contain one payment scheme's transactions.\n"},{"$ref":"#/components/schemas/BaseMessage"},{"properties":{"bulkPaymentSchemeName":{"$ref":"#/components/schemas/PaymentSchemeName"},"initiatingParty":{"$ref":"#/components/schemas/Party"},"numberOfTransactions":{"description":"The total number of transactions in the bulk.","minimum":1,"type":"integer"},"requestToPayInformationId":{"description":"Universally unique identifier to identify the bulk collection itself.\n","format":"UUID","type":"string"},"requestToPayInitiationInstructions":{"description":"List of instructions to initiate each request to pay within the bulk with other financial institutions or the partner bank.","items":{"$ref":"#/components/schemas/RequestToPayInitiationInstruction"},"minItems":1,"type":"array"}},"required":["requestToPayInformationId","bulkPaymentSchemeName","requestToPayInitiationInstructions"],"type":"object"}]}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum checks that:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The number of RTPs in the bulk matches the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numberOfTransactions"]}," value that you have indicated in the request message."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The transaction amounts for each RTP are valid. (Note that any invalid RTPs will be deemed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}," and will not be processed further.)"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum debulks the request and sends each individual RTP to industry."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once all valid RTPs have reached their destination banks, Electrum will rebulk the individual RTPs and send a bulk response to you using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPayResponse"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/bulk/outboundbulkrequesttopayresponse"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiationResponse"]}," schema), showing the current status of the bulk."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A payer at the industry bank declines an individual RTP request and BankservAfrica notifies Electrum."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum sends an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundRequestToPayResponse"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/request-to-pay/outboundrequesttopayresponse"},"children":["message"]},", containing a status code of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}," for that individual rejected RTP, to you. You return an acknowledgement (ACK, HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},"). The payee is informed that the payer declined to pay."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum updates the status in the RTP Store to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},"."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rtp-cancellation"},"children":["RTP Cancellation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/bulk-rtp-cancel.279a5a40e5f3594748bf09751311d061be0ecdbb82100beb39db5bb65d499353.586f3b22.svg","alt":"bulk rtp cancel"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a bulk RTP request to Electrum using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPay"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-redoc/bulk/outboundbulkrequesttopay"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiation"]}," schema). For each bulk request you must generate a bulk ID and populate this value in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestToPayInformationId"]}," field. List the individual RTP requests as an array of objects in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestToPayInitiationInstructions"]}," field."]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["RequestToPayInitiation Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/RequestToPayInitiation"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/RequestToPayInitiation"},"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"},"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"},"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"},"PhoneNumber":{"pattern":"^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$","type":"string"},"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"},"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"},"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"},"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"},"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"},"BankingIdentifier":{"discriminator":{"mapping":{"GENERIC":"#/components/schemas/GenericAccountIdentifier","IBAN":"#/components/schemas/IBANIdentifier"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/IBANIdentifier"},{"$ref":"#/components/schemas/GenericAccountIdentifier"}],"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"},"CustomIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"maxLength":2048,"minLength":1,"type":"string"}},"required":["value"],"type":"object"}]},"MobileNumberIdentifier":{"allOf":[{"$ref":"#/components/schemas/NonBankingIdentifier"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}},"required":["value"],"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"RequestToPayConditions":{"description":"Describes the various aspects of a request to pay which must be\naccepted or to what extent they may be altered.\n","properties":{"maxAmount":{"$ref":"#/components/schemas/Amount","description":"The maximum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"},"minAmount":{"$ref":"#/components/schemas/Amount","description":"The minimum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"}},"required":["minAmount","maxAmount"],"type":"object"},"TaxInformation":{"properties":{"totalAmount":{"$ref":"#/components/schemas/Amount"}},"required":["totalAmount"],"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"},"RequestToPayInitiationInstruction":{"description":"Initiation instruction object. This is a striped down version of the requestToPay model with the fields that can be\ninferred from the bulk information removed.\n","properties":{"creditor":{"$ref":"#/components/schemas/Party"},"creditorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"creditorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"debtor":{"$ref":"#/components/schemas/Party"},"debtorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"expiryDateTime":{"description":"Date and time at which the request to pay expires. Some schemes\nmay still permit a payment after the request to pay expires. Upon\nexpiry, the following schemes will reject an associated payment: ZA_RPP.\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"},"instructionForDebtorAgent":{"description":"Further information related to the processing of the payment instruction, provided by the\ninitiating party, and intended for the debtor agent.\n","items":{"$ref":"#/components/schemas/CreditorAgentInstruction"},"minItems":0,"type":"array"},"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation"},"purpose":{"$ref":"#/components/schemas/PurposeType"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation"},"requestToPayConditions":{"$ref":"#/components/schemas/RequestToPayConditions"},"tax":{"$ref":"#/components/schemas/TaxInformation"},"transactionIdentifiers":{"$ref":"#/components/schemas/TransactionIdentifiers"}},"required":["messageIdentifiers","transactionIdentifiers","expiryDateTime","requestToPayConditions","creditor","creditorAccount","creditorAgent","debtorAccount","paymentTypeInformation","remittanceInformation"],"type":"object"},"RequestToPayInitiation":{"allOf":[{"description":"Object used to initiate a bulk of request to pay transactions. The transactions are defined in the `requestToPayInitiationInstructions`\narray. The bulk can only contain one payment scheme's transactions.\n"},{"$ref":"#/components/schemas/BaseMessage"},{"properties":{"bulkPaymentSchemeName":{"$ref":"#/components/schemas/PaymentSchemeName"},"initiatingParty":{"$ref":"#/components/schemas/Party"},"numberOfTransactions":{"description":"The total number of transactions in the bulk.","minimum":1,"type":"integer"},"requestToPayInformationId":{"description":"Universally unique identifier to identify the bulk collection itself.\n","format":"UUID","type":"string"},"requestToPayInitiationInstructions":{"description":"List of instructions to initiate each request to pay within the bulk with other financial institutions or the partner bank.","items":{"$ref":"#/components/schemas/RequestToPayInitiationInstruction"},"minItems":1,"type":"array"}},"required":["requestToPayInformationId","bulkPaymentSchemeName","requestToPayInitiationInstructions"],"type":"object"}]}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum checks that:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The number of RTPs in the bulk matches the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numberOfTransactions"]}," value that you have indicated in the request message."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The transaction amounts for each RTP are valid. (Note that any invalid RTPs will be deemed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}," and will not be processed further.)"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum debulks the request and sends each individual RTP to industry."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once all valid RTPs have reached their destination banks, Electrum will rebulk the individual RTPs and send a bulk response to you using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundBulkRequestToPayResponse"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/bulk/outboundbulkrequesttopayresponse"},"children":["operation"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayInitiationResponse"]}," schema), showing the current status of the bulk."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You send an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundRequestToPayCancellationRequest"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-redoc/request-to-pay/outboundrequesttopaycancellationrequest"},"children":["message"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayCancellation"]}," schema) to Electrum to cancel the RTP, and Electrum returns an acknowledgement (ACK, HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},")."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["RequestToPayCancellation Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-redoc.yaml#/components/schemas/RequestToPayCancellation"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/RequestToPayCancellation"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"RequestToPayConditions":{"description":"Describes the various aspects of a request to pay which must be\naccepted or to what extent they may be altered.\n","properties":{"maxAmount":{"$ref":"#/components/schemas/Amount","description":"The maximum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"},"minAmount":{"$ref":"#/components/schemas/Amount","description":"The minimum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"}},"required":["minAmount","maxAmount"],"type":"object"},"OriginalRequestToPayData":{"description":"Contains key elements related to the original request to pay that is being referred to.\n","properties":{"amounts":{"$ref":"#/components/schemas/TransactionAmounts"},"creditor":{"$ref":"#/components/schemas/Party"},"creditorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"creditorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"debtor":{"$ref":"#/components/schemas/Party"},"debtorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"expiryDateTime":{"description":"Date and time at which the request to pay expires. Some schemes\nmay still permit a payment after the request to pay expires. Upon\nexpiry, the following schemes will reject an associated payment: ZA_RPP.\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"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation"},"requestToPayConditions":{"$ref":"#/components/schemas/RequestToPayConditions"}},"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"},"RequestToPayCancellation":{"description":"Requests that a prior request to pay is cancelled if possible (e.g. it's not yet been actioned, rejected or expired).\n","properties":{"instructedAgent":{"$ref":"#/components/schemas/InstitutionIdentification","description":"The instructed agent is the party receiving the cancellation message.\n"},"instructingAgent":{"$ref":"#/components/schemas/InstitutionIdentification","description":"The instructing agent is the party sending the cancellation message.\n"},"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"originalMessageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"originalRequestToPayData":{"$ref":"#/components/schemas/OriginalRequestToPayData"},"originalTransactionIdentifiers":{"$ref":"#/components/schemas/TransactionIdentifiers"},"reasonCode":{"description":"The reason the request to pay is being cancelled.\n- `AC03`: InvalidCreditorAccountNumber - Wrong account number in Credit Transfer.\n- `AGNT`: IncorrectAgent- Agent in the payment workflow is incorrect.\n- `AM09`: WrongAmount- Amount is not the amount agreed or expected.\n- `BE16`: InvalidDebtorIdentificationCode- Debtor or Ultimate Debtor identification code missing or invalid.\n- `COVR`: CoverCancelledOrReturned- Cover payments has either been returned or cancelled.\n- `CURR`: IncorrectCurrency- Currency of the payment is incorrect.\n- `CUST`: RequestedByCustomer- Cancellation requested by the Creditor.\n- `CUTA`: CancelUponUnableToApply- Cancellation requested because an investigation request has been received and no remediation is possible.\n- `DS24`: TimeOut- Cancellation requested because the original payment order expired due to time-out.\n- `DT01`: InvalidDate- Invalid date (for example, wrong or missing settlement date).\n- `DUPL`: DuplicatePayment- Payment is a duplicate of another payment.\n- `FRAD`: FraudulentOrigin- Cancellation requested following a transaction that was originated fraudulently. The use of the FraudulentOrigin code should be governed by jurisdictions.\n- `FRNA`: ForwardToNextAgent- To complement a rejection response, suggesting the request for cancelation should be forwarded to the next agent in the payment transaction chain.\n- `FRTR`: FinalResponse- Direct Debit Tracking recalled as Mandate Cancelled\n- `INDM`: IndemnityRequired- To express the wish to establish a bilateral indemnity agreement.\n- `MODT`: ModifiedTransaction- The underlying transaction in relation to an RTP was modified.\n- `PAID`: TransactionAlreadyPaid- The underlying transaction in relation to an RTP was already paid (via other means).\n- `SVNR`: ServiceNotRendered- The payment is cancelled since a cash amount rendered was not correct or goods or a service was not rendered to the customer, e.g. in an e-commerce situation.\n- `SYAD`: RequestToSettlementSystemAdministrator- Cancellation requested by System Member to Settlement System Administrator to indicate that the cancellation request must not be forwarded further in the chain.\n- `TECH`: TechnicalProblem- Cancellation requested following technical problems resulting in an erroneous transaction.\n- `UPAY`: UnduePayment- Payment is not justified.\n- `ENUE`: EndUserError- Cancellation or request for return requested by the Debtor specifically due to one or more errors by debtor in the original Credit Transfer. Usage: This code can be used for any error in the original Credit Transfer made by the Debtor. Can also be used if multiple errors were made in the original Credit Transfer.\n- `UAPA`: UnauthorizedPayment- \"The Debtor is requesting a return of the payment because the payment was not properly authorized. Usage: This code can be used in the case where a Credit Transfer was made without proper authorization from the Debtor. This could be due to compromised end user credentials.\"\n- `NARR`: Narrative- Reason is provided as narrative information in the additional reason information.\n- `AC02`: InvalidDebtorAccountNumber- Debtor account number invalid or missing.\n- `BIAS`: BatchInstructionAlreadySettled- Process a cancellation request but batch already settled.\n- `INCR`: InvalidCancellationRequest- Process a cancellation request with incorrect reference to original batch.\n- `DRTP`: DuplicationRequestToPay- Duplication of a request-to-pay message.\n","enum":["AC03","AGNT","AM09","BE16","COVR","CURR","CUST","CUTA","DS24","DT01","DUPL","FRAD","FRNA","FRTR","INDM","MODT","PAID","SVNR","SYAD","TECH","UPAY","ENUE","UAPA","NARR","AC02","BIAS","INCR","DRTP"],"type":"string"},"reasonDescription":{"description":"A description of the reason the request to pay is being cancelled.","type":"string"},"schema":{"enum":["RequestToPayCancellation"],"type":"string"}},"required":["reasonCode","schema","messageIdentifiers","originalMessageIdentifiers","originalTransactionIdentifiers"],"type":"object"}}}},"schemaResolvedErrors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":6},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum forwards the cancellation to BankservAfrica. Note: Electrum will not first verify that a cancellation request (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundRequestToPayCancellationRequest"]},") received from a corporate client is linked to a prior RTP request. Electrum will merely forward the cancellation as soon as we receive it from you."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum receives notification from BankservAfrica that the payment was successfully cancelled."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electrum sends an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outboundRequestToPayCancellationResponse"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/epc-cicd/epc-elpapi-partner-redoc/request-to-pay/outboundrequesttopaycancellationresponse"},"children":["message"]}," to you (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestToPayCancellationResponse"]}," schema), and you return an acknowledgement (ACK, HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},")."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{"closed":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["RequestToPayCancellationResponse Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi/epc-cicd/epc-elpapi-partner-redoc.yaml#/components/schemas/RequestToPayCancellationResponse"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/RequestToPayCancellationResponse"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"RequestToPayConditions":{"description":"Describes the various aspects of a request to pay which must be\naccepted or to what extent they may be altered.\n","properties":{"maxAmount":{"$ref":"#/components/schemas/Amount","description":"The maximum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"},"minAmount":{"$ref":"#/components/schemas/Amount","description":"The minimum payment amount that is acceptable to the payee. This does not supersede the scheme limit.\n"}},"required":["minAmount","maxAmount"],"type":"object"},"OriginalRequestToPayData":{"description":"Contains key elements related to the original request to pay that is being referred to.\n","properties":{"amounts":{"$ref":"#/components/schemas/TransactionAmounts"},"creditor":{"$ref":"#/components/schemas/Party"},"creditorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"creditorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"debtor":{"$ref":"#/components/schemas/Party"},"debtorAccount":{"$ref":"#/components/schemas/PaymentAccount"},"debtorAgent":{"$ref":"#/components/schemas/InstitutionIdentification"},"expiryDateTime":{"description":"Date and time at which the request to pay expires. Some schemes\nmay still permit a payment after the request to pay expires. Upon\nexpiry, the following schemes will reject an associated payment: ZA_RPP.\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"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation"},"requestToPayConditions":{"$ref":"#/components/schemas/RequestToPayConditions"}},"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"},"RequestToPayCancellationStatusReasonTypeCode":{"properties":{"schema":{"description":"Identifies the value as being a pre-defined code. Always `CODE`.","type":"string"},"value":{"description":"* `AC04`: ClosedAccountNumber - Account number specified has been closed on the receiver’s books.\n* `ADAC`: AwaitingDebitAuthorityFromCustomer - Reported when the cancellation request cannot be processed because customer has not yet provided the debit authority on its account.\n* `AGNT`: AgentDecision - Reported when the cancellation cannot be accepted because of an agent refuses to cancel.\n* `AM04`: InsufficientFunds - Amount of funds available to cover specified message amount is insufficient.\n* `ARDT`: AlreadyReturned - Cancellation not accepted as the transaction has already been returned.\n* `ARPL`: AwaitinReply - Reported when the cancellation request cannot be processed because no reply has been  received yet from the receiver of the request message.\n* `CUST`: CustomerDecision - Reported when the cancellation cannot be accepted because of a customer decision (Creditor).\n* `LEGL`: LegalDecision - Reported when the cancellation cannot be accepted because of regulatory rules.\n* `NARR`: Narrative - Reason is provided as narrative information in the additional reason information.\n* `NOAS`: NoAnswerFromCustomer - No response from beneficiary (to the cancellation request).\n* `NOOR`: NoOriginalTransactionReceived - Original transaction (subject to cancellation) never received.\n* `PTNA`: PassedToTheNextAgent - Reported when the cancellation request cannot be accepted because the payment instruction has been passed to the next agent.\n* `RQDA`: RequestingDebitAuthority - Reported when authority is required by the Creditor to return the payment.\n* `WSEQ`: WrongSequence - Reported when the cancellation request cannot be processed because the sequence referred to in the request is not valid.\n* `IDMN`: CancellationIndemnityRequired - Complementing a Pending or Reject Status. Payment cancellation request cannot be accepted until an indemnity agreement is established.\n* `ACLR`: AlreadyCancelledRTP - Request-to-pay has already been cancelled.\n* `AEXR`: AlreadyExpiredRTP - Request-to-pay Expiry Date and Time has already passed.\n* `ARFR`: AlreadyRefusedRTP - Request-to-pay has already been refused by the Debtor.\n* `ARJR`: AlreadyRejectedRTP - Request-to-pay has already been rejected.\n* `PATE`: PaymentAlreadyTransmittedExecution - Payment related to the request-to-pay has already been transmitted for execution.\n* `RR04`: RegulatoryReason - Regulatory Reason.\n* `RCAR`: RfCAlreadyRejected - Request for cancellation of the request-to-pay has already been rejected.\n* `RCNR`: RfCNeverReceived - Request for cancellation of the request-to-pay has never been received.\n* `RCPR`: RfCReceivedAndProcessed - Request for cancellation of the request-to-pay has already been received and processed.\n* `URTP`: UnknownRTP - Request-to-pay is unknown.\n","enum":["AC04","ADAC","AGNT","AM04","ARDT","ARPL","CUST","LEGL","NARR","NOAS","NOOR","PTNA","RQDA","WSEQ","IDMN","ACLR","AEXR","ARFR","ARJR","PATE","RR04","RCAR","RCNR","RCPR","URTP"],"type":"string"}},"required":["schema","value"],"type":"object"},"RequestToPayCancellationStatusReasonType":{"discriminator":{"mapping":{"CODE":"#/components/schemas/RequestToPayCancellationStatusReasonTypeCode","PROPRIETARY":"#/components/schemas/ProprietaryValue"},"propertyName":"schema"},"oneOf":[{"$ref":"#/components/schemas/RequestToPayCancellationStatusReasonTypeCode"},{"$ref":"#/components/schemas/ProprietaryValue"}],"type":"object"},"RequestToPayCancellationStatusReasonInfo":{"description":"Provides detailed information on a cancellation 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/RequestToPayCancellationStatusReasonType"}},"required":["reason"],"type":"object"},"RequestToPayCancellationStatus":{"properties":{"reasonInfo":{"description":"A list of `RequestToPayCancellationStatusReasonInfo` values providing detailed reason information for the status.\n","items":{"$ref":"#/components/schemas/RequestToPayCancellationStatusReasonInfo"},"minItems":1,"type":"array"},"status":{"description":"* `CANCELLED`: Cancelled - The cancellation was successfully processed and the request for payment has been cancelled.\n* `REJECTED`: Rejected - The cancellation was rejected. Refer to the `reasonInfo` for further information.\n","enum":["CANCELLED","REJECTED"],"type":"string"}},"required":["status"],"type":"object"},"RequestToPayCancellationResponse":{"description":"Provides the outcome of a prior request to pay cancellation.\n","properties":{"instructedAgent":{"$ref":"#/components/schemas/InstitutionIdentification","description":"The instructed agent is the party receiving the cancellation response message and not the party that received the\noriginal cancellation instruction that is being reported on.\n"},"instructingAgent":{"$ref":"#/components/schemas/InstitutionIdentification","description":"The instructing agent is the party sending the cancellation response message and not the party that sent the original\ncancellation instruction that is being reported on.\n"},"messageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"originalMessageIdentifiers":{"$ref":"#/components/schemas/MessageIdentifiers"},"originalRequestToPayData":{"$ref":"#/components/schemas/OriginalRequestToPayData"},"originalTransactionIdentifiers":{"$ref":"#/components/schemas/TransactionIdentifiers"},"schema":{"enum":["RequestToPayCancellationResponse"],"type":"string"},"status":{"$ref":"#/components/schemas/RequestToPayCancellationStatus"}},"required":["status","schema","messageIdentifiers","originalMessageIdentifiers","originalTransactionIdentifiers"],"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":"outboundRequestToPayResponse","exampleKey":"RequestToPayCancellationResponseCancelled","language":"Payload","parameters":{},"options":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":9},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum updates the status in the RTP Store to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]},"."]}]}]},"headings":[{"value":"Bulk RTP","id":"bulk-rtp","depth":1},{"value":"RTP Acceptance","id":"rtp-acceptance","depth":2},{"value":"RTP Decline","id":"rtp-decline","depth":2},{"value":"RTP Cancellation","id":"rtp-cancellation","depth":2}],"frontmatter":{"seo":{"title":"Bulk RTP"}},"lastModified":"2025-10-01T07:53:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/epc/public/bulk-rtp","userData":{"isAuthenticated":false,"teams":["anonymous"]}}