{"openapi":"3.0.0","info":{"title":"10x Australian Payments","description":"10x Australia, Payments","version":"1.1.2"},"servers":[{"url":"/"}],"tags":[{"name":"payment-initiation","description":"Initiate a new payment"},{"name":"payment-execution","description":"Execute off-us payments by generating and submitting a payment batch to an external execution system"}],"paths":{"/v1/payments/customerCreditTransferInitiation":{"post":{"tags":["payment-initiation"],"summary":"Initiates a new customer credit transfer (ISO pain.001)","description":"This endpoint is based on the ISO 20022 pain.001 message type (version 09) to initiate a new credit transfer. \n\n**It is currently used for Australian payments only!**\n","parameters":[{"name":"Authorization","in":"header","description":"Authorization","style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"The request to initiate a payment in pain.001 format (pain.001.x01.09).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pain001"},"examples":{"au_becs_ct":{"$ref":"#/components/examples/request_au_becs_ct"}}}}},"responses":{"201":{"description":"Created. The platform has accepted the request and processing is complete. The response contains a final payment status report (pain.002) with a positive or negative status. A negative status will be returned with reason information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pain002"},"examples":{"response_201_rjct":{"$ref":"#/components/examples/response_201_rjct"}}}}},"202":{"description":"Accepted. The platform has accepted the request but processing is not yet complete. The response contains a payment status report (pain.002) with a pending status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pain002"},"examples":{"response_201_rjct":{"$ref":"#/components/examples/response_202_accp"}}}}},"400":{"description":"Bad request. Request is malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}},"403":{"description":"Forbidden. Initiating party is not authorised on the debtor account included in the payment request or 10x token is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}},"422":{"description":"Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/v1/payments/executionSystem/{executionSystemIdentification}/submission/{submissionIdentification}":{"post":{"tags":["payment-execution"],"summary":"Creates and submits a clearing batch to an external execution system","description":"This endpoint is used to trigger the creation and submission of a clearing batch (e.g. in ISO pacs.008 format), i.e. all off-us transactions queued for later submission will be batched and sent to an external (batch) execution system.\n\n**It is currently used for Australian payments only!**\n","parameters":[{"name":"executionSystemIdentification","in":"path","description":"Identification of the execution system as configured on the platform.","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/Max35Text"},"example":"AU_DE"},{"name":"submissionIdentification","in":"path","description":"Identification of the submission, used as a message identification when generating the payment batch.","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/Max32Text"},"example":20200204171119}],"requestBody":{"description":"The request to create and submit a clearing batch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchClearingRequest"},"examples":{"trigger":{"$ref":"#/components/examples/request_trigger"}}}}},"responses":{"202":{"description":"The request has been successfully accepted. The number of transactions found for submission will be returned in the response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchClearingResponse"},"examples":{"response_trigger_202":{"$ref":"#/components/examples/response_trigger_202"}}}}},"400":{"description":"Bad request. Request is malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}},"404":{"description":"Not Found. Invalid execution system identification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}},"422":{"description":"Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}}},"components":{"schemas":{"BatchClearingRequest":{"required":["creationDateTime","schemeIdentification"],"type":"object","properties":{"creationDateTime":{"allOf":[{"$ref":"#/components/schemas/ISODateTime"},{"description":"The creation date and time of the request"}]},"schemeIdentification":{"allOf":[{"$ref":"#/components/schemas/Max35Text"},{"description":"The identification of the scheme as configured on the platform"}]},"batchLimit":{"allOf":[{"$ref":"#/components/schemas/Max15NumericText"},{"description":"Maximum number of transactions to be included in a batch message. This value will overwrite the maximum number of transactions configured on the platform if provided."}]},"simulation":{"allOf":[{"$ref":"#/components/schemas/SimulationIndicator"},{"description":"Can be used to simulate a submission (\"true\") and return the number of transactions available for processing without generating a batch. Default is \"false\"."}]}}},"BaseOneRate":{"type":"number"},"DecimalNumber":{"type":"number"},"ISODate":{"type":"string","format":"date-time"},"ISODateTime":{"type":"string","format":"date-time"},"Number":{"type":"number"},"PercentageRate":{"type":"number"},"TrueFalseIndicator":{"type":"boolean"},"AddressType2Code":{"type":"string","enum":["ADDR","PBOX","HOME","BIZZ","MLTO","DLVY"]},"ChargeBearerType1Code":{"type":"string","enum":["DEBT","CRED","SHAR","SLEV"]},"CreditDebitCode":{"type":"string","enum":["CRDT","DBIT"]},"DocumentType3Code":{"type":"string","enum":["RADM","RPIN","FXDR","DISP","PUOR","SCOR"]},"DocumentType6Code":{"type":"string","enum":["MSIN","CNFA","DNFA","CINV","CREN","DEBN","HIRI","SBIN","CMCN","SOAC","DISP","BOLD","VCHR","AROI","TSUT","PUOR"]},"NamePrefix2Code":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"PreferredContactMethod1Code":{"type":"string","enum":["LETT","MAIL","PHON","FAXX","CELL"]},"Priority2Code":{"type":"string","enum":["HIGH","NORM"]},"TaxRecordPeriod1Code":{"type":"string","enum":["MM01","MM02","MM03","MM04","MM05","MM06","MM07","MM08","MM09","MM10","MM11","MM12","QTR1","QTR2","QTR3","QTR4","HLF1","HLF2"]},"ActiveOrHistoricCurrencyAndAmount_SimpleType":{"minimum":0,"exclusiveMinimum":false,"type":"number"},"ActiveOrHistoricCurrencyCode":{"pattern":"[A-Z]{3,3}","type":"string"},"AnyBICDec2014Identifier":{"pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}","type":"string"},"BICFIDec2014Identifier":{"pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}","type":"string"},"CountryCode":{"pattern":"[A-Z]{2,2}","type":"string"},"Exact4AlphaNumericText":{"pattern":"[a-zA-Z0-9]{4}","type":"string"},"ExternalAccountIdentification1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalCashAccountType1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalCategoryPurpose1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalClearingSystemIdentification1Code":{"maxLength":5,"minLength":1,"type":"string"},"ExternalDiscountAmountType1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalDocumentLineType1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalFinancialInstitutionIdentification1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalGarnishmentType1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalLocalInstrument1Code":{"maxLength":35,"minLength":1,"type":"string"},"ExternalOrganisationIdentification1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalPersonIdentification1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalProxyAccountType1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalPurpose1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalServiceLevel1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalTaxAmountType1Code":{"maxLength":4,"minLength":1,"type":"string"},"IBAN2007Identifier":{"pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"LEIIdentifier":{"pattern":"[A-Z0-9]{18,18}[0-9]{2,2}","type":"string"},"Max128Text":{"maxLength":128,"minLength":1,"type":"string"},"Max140Text":{"maxLength":140,"minLength":1,"type":"string"},"Max15NumericText":{"pattern":"[0-9]{1,15}","type":"string"},"Max16Text":{"maxLength":16,"minLength":1,"type":"string"},"Max2048Text":{"maxLength":2048,"minLength":1,"type":"string"},"Max34Text":{"maxLength":34,"minLength":1,"type":"string"},"Max350Text":{"maxLength":350,"minLength":1,"type":"string"},"Max35Text":{"maxLength":35,"minLength":1,"type":"string"},"Max4Text":{"maxLength":4,"minLength":1,"type":"string"},"Max70Text":{"maxLength":70,"minLength":1,"type":"string"},"Max32Text":{"maxLength":32,"minLength":1,"type":"string"},"PhoneNumber":{"pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}","type":"string"},"UUIDv4Identifier":{"pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}","type":"string"},"AccountIdentification4Choice":{"oneOf":[{"properties":{"IBAN":{"$ref":"#/components/schemas/IBAN2007Identifier"},"other":{"$ref":"#/components/schemas/GenericAccountIdentification1"}}}]},"AccountSchemeName1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalAccountIdentification1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"AddressType3Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/AddressType2Code"},"proprietary":{"$ref":"#/components/schemas/GenericIdentification30"}}}]},"AmountType4Choice":{"type":"object","oneOf":[{"properties":{"instructedAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"equivalentAmount":{"$ref":"#/components/schemas/EquivalentAmount2"}}}]},"BranchAndFinancialInstitutionIdentification6":{"required":["financialInstitutionIdentification"],"type":"object","properties":{"financialInstitutionIdentification":{"$ref":"#/components/schemas/FinancialInstitutionIdentification18"},"branchIdentification":{"$ref":"#/components/schemas/BranchData3"}}},"BranchData3":{"type":"object","properties":{"identification":{"$ref":"#/components/schemas/Max35Text"},"LEI":{"$ref":"#/components/schemas/LEIIdentifier"},"name":{"$ref":"#/components/schemas/Max140Text"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress24"}}},"CashAccount38":{"required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/AccountIdentification4Choice"},"type":{"$ref":"#/components/schemas/CashAccountType2Choice"},"currency":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyCode"},"name":{"$ref":"#/components/schemas/Max70Text"},"proxy":{"$ref":"#/components/schemas/ProxyAccountIdentification1"}}},"CashAccountType2Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalCashAccountType1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"CategoryPurpose1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalCategoryPurpose1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"ClearingSystemIdentification2Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalClearingSystemIdentification1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"ClearingSystemMemberIdentification2":{"required":["memberIdentification"],"type":"object","properties":{"clearingSystemIdentification":{"$ref":"#/components/schemas/ClearingSystemIdentification2Choice"},"memberIdentification":{"$ref":"#/components/schemas/Max35Text"}}},"Contact4":{"type":"object","properties":{"namePrefix":{"$ref":"#/components/schemas/NamePrefix2Code"},"name":{"$ref":"#/components/schemas/Max140Text"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"mobileNumber":{"$ref":"#/components/schemas/PhoneNumber"},"faxNumber":{"$ref":"#/components/schemas/PhoneNumber"},"emailAddress":{"$ref":"#/components/schemas/Max2048Text"},"emailPurpose":{"$ref":"#/components/schemas/Max35Text"},"jobTitle":{"$ref":"#/components/schemas/Max35Text"},"responsibility":{"$ref":"#/components/schemas/Max35Text"},"department":{"$ref":"#/components/schemas/Max70Text"},"other":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/OtherContact1"}},"preferredMethod":{"$ref":"#/components/schemas/PreferredContactMethod1Code"}}},"CreditorReferenceInformation2":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CreditorReferenceType2"},"reference":{"$ref":"#/components/schemas/Max35Text"}}},"CreditorReferenceType1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/DocumentType3Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"CreditorReferenceType2":{"required":["codeOrProprietary"],"type":"object","properties":{"codeOrProprietary":{"$ref":"#/components/schemas/CreditorReferenceType1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"DateAndDateTime2Choice":{"oneOf":[{"properties":{"date":{"$ref":"#/components/schemas/ISODate"},"dateTime":{"$ref":"#/components/schemas/ISODateTime"}}}]},"DateAndPlaceOfBirth1":{"required":["birthDate","cityOfBirth","countryOfBirth"],"type":"object","properties":{"birthDate":{"$ref":"#/components/schemas/ISODate"},"provinceOfBirth":{"$ref":"#/components/schemas/Max35Text"},"cityOfBirth":{"$ref":"#/components/schemas/Max35Text"},"countryOfBirth":{"$ref":"#/components/schemas/CountryCode"}}},"DatePeriod2":{"required":["fromDate","toDate"],"type":"object","properties":{"fromDate":{"$ref":"#/components/schemas/ISODate"},"toDate":{"$ref":"#/components/schemas/ISODate"}}},"DiscountAmountAndType1":{"required":["amount"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/DiscountAmountType1Choice"},"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"}}},"DiscountAmountType1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalDiscountAmountType1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"DocumentAdjustment1":{"required":["amount"],"type":"object","properties":{"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"creditDebitIndicator":{"$ref":"#/components/schemas/CreditDebitCode"},"reason":{"$ref":"#/components/schemas/Max4Text"},"additionalInformation":{"$ref":"#/components/schemas/Max140Text"}}},"DocumentLineIdentification1":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentLineType1"},"number":{"$ref":"#/components/schemas/Max35Text"},"relatedDate":{"$ref":"#/components/schemas/ISODate"}}},"DocumentLineInformation1":{"required":["identification"],"type":"object","properties":{"identification":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/DocumentLineIdentification1"}},"description":{"$ref":"#/components/schemas/Max2048Text"},"amount":{"$ref":"#/components/schemas/RemittanceAmount3"}}},"DocumentLineType1":{"required":["codeOrProprietary"],"type":"object","properties":{"codeOrProprietary":{"$ref":"#/components/schemas/DocumentLineType1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"DocumentLineType1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalDocumentLineType1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"EquivalentAmount2":{"required":["amount","currencyOfTransfer"],"type":"object","properties":{"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"currencyOfTransfer":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyCode"}}},"FinancialIdentificationSchemeName1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalFinancialInstitutionIdentification1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"FinancialInstitutionIdentification18":{"type":"object","properties":{"BICFI":{"$ref":"#/components/schemas/BICFIDec2014Identifier"},"clearingSystemMemberIdentification":{"$ref":"#/components/schemas/ClearingSystemMemberIdentification2"},"LEI":{"$ref":"#/components/schemas/LEIIdentifier"},"name":{"$ref":"#/components/schemas/Max140Text"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress24"},"other":{"$ref":"#/components/schemas/GenericFinancialIdentification1"}}},"Garnishment3":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/GarnishmentType1"},"garnishee":{"$ref":"#/components/schemas/PartyIdentification135"},"garnishmentAdministrator":{"$ref":"#/components/schemas/PartyIdentification135"},"referenceNumber":{"$ref":"#/components/schemas/Max140Text"},"date":{"$ref":"#/components/schemas/ISODate"},"remittedAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"familyMedicalInsuranceIndicator":{"$ref":"#/components/schemas/TrueFalseIndicator"},"employeeTerminationIndicator":{"$ref":"#/components/schemas/TrueFalseIndicator"}}},"GarnishmentType1":{"required":["codeOrProprietary"],"type":"object","properties":{"codeOrProprietary":{"$ref":"#/components/schemas/GarnishmentType1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"GarnishmentType1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalGarnishmentType1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"GenericAccountIdentification1":{"required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/Max34Text"},"schemeName":{"$ref":"#/components/schemas/AccountSchemeName1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"GenericFinancialIdentification1":{"required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/Max35Text"},"schemeName":{"$ref":"#/components/schemas/FinancialIdentificationSchemeName1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"GenericIdentification30":{"required":["identification","issuer"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/Exact4AlphaNumericText"},"issuer":{"$ref":"#/components/schemas/Max35Text"},"schemeName":{"$ref":"#/components/schemas/Max35Text"}}},"GenericOrganisationIdentification1":{"required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/Max35Text"},"schemeName":{"$ref":"#/components/schemas/OrganisationIdentificationSchemeName1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"GenericPersonIdentification1":{"required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/Max35Text"},"schemeName":{"$ref":"#/components/schemas/PersonIdentificationSchemeName1Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"LocalInstrument2Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalLocalInstrument1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"OrganisationIdentification29":{"type":"object","properties":{"anyBIC":{"$ref":"#/components/schemas/AnyBICDec2014Identifier"},"LEI":{"$ref":"#/components/schemas/LEIIdentifier"},"other":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/GenericOrganisationIdentification1"}}}},"OrganisationIdentificationSchemeName1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalOrganisationIdentification1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"OtherContact1":{"required":["channelType"],"type":"object","properties":{"channelType":{"$ref":"#/components/schemas/Max4Text"},"identification":{"$ref":"#/components/schemas/Max128Text"}}},"Party38Choice":{"oneOf":[{"properties":{"organisationIdentification":{"$ref":"#/components/schemas/OrganisationIdentification29"},"privateIdentification":{"$ref":"#/components/schemas/PersonIdentification13"}}}]},"PartyIdentification135":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Max140Text"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress24"},"identification":{"$ref":"#/components/schemas/Party38Choice"},"countryOfResidence":{"$ref":"#/components/schemas/CountryCode"},"contactDetails":{"$ref":"#/components/schemas/Contact4"}}},"PersonIdentification13":{"type":"object","properties":{"dateAndPlaceOfBirth":{"$ref":"#/components/schemas/DateAndPlaceOfBirth1"},"other":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/GenericPersonIdentification1"}}}},"PersonIdentificationSchemeName1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalPersonIdentification1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"PostalAddress24":{"type":"object","properties":{"addressType":{"$ref":"#/components/schemas/AddressType3Choice"},"department":{"$ref":"#/components/schemas/Max70Text"},"subDepartment":{"$ref":"#/components/schemas/Max70Text"},"streetName":{"$ref":"#/components/schemas/Max70Text"},"buildingNumber":{"$ref":"#/components/schemas/Max16Text"},"buildingName":{"$ref":"#/components/schemas/Max35Text"},"floor":{"$ref":"#/components/schemas/Max70Text"},"postBox":{"$ref":"#/components/schemas/Max16Text"},"room":{"$ref":"#/components/schemas/Max70Text"},"postCode":{"$ref":"#/components/schemas/Max16Text"},"townName":{"$ref":"#/components/schemas/Max35Text"},"townLocationName":{"$ref":"#/components/schemas/Max35Text"},"districtName":{"$ref":"#/components/schemas/Max35Text"},"countrySubDivision":{"$ref":"#/components/schemas/Max35Text"},"country":{"$ref":"#/components/schemas/CountryCode"},"addressLine":{"maxItems":7,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max70Text"}}}},"ProxyAccountIdentification1":{"required":["identification"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/ProxyAccountType1Choice"},"identification":{"$ref":"#/components/schemas/Max2048Text"}}},"ProxyAccountType1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalProxyAccountType1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"Purpose2Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalPurpose1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"ReferredDocumentInformation7":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ReferredDocumentType4"},"number":{"$ref":"#/components/schemas/Max35Text"},"relatedDate":{"$ref":"#/components/schemas/ISODate"},"lineDetails":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DocumentLineInformation1"}}}},"ReferredDocumentType3Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/DocumentType6Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"ReferredDocumentType4":{"required":["codeOrProprietary"],"type":"object","properties":{"codeOrProprietary":{"$ref":"#/components/schemas/ReferredDocumentType3Choice"},"issuer":{"$ref":"#/components/schemas/Max35Text"}}},"RemittanceAmount2":{"type":"object","properties":{"duePayableAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"discountAppliedAmount":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DiscountAmountAndType1"}},"creditNoteAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"taxAmount":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/TaxAmountAndType1"}},"adjustmentAmountAndReason":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DocumentAdjustment1"}},"remittedAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"}}},"RemittanceAmount3":{"type":"object","properties":{"duePayableAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"discountAppliedAmount":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DiscountAmountAndType1"}},"creditNoteAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"taxAmount":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/TaxAmountAndType1"}},"adjustmentAmountAndReason":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DocumentAdjustment1"}},"remittedAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"}}},"RemittanceInformation16":{"type":"object","properties":{"unstructured":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max140Text"}},"structured":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/StructuredRemittanceInformation16"}}}},"ServiceLevel8Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalServiceLevel1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"StructuredRemittanceInformation16":{"type":"object","properties":{"referredDocumentInformation":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ReferredDocumentInformation7"}},"referredDocumentAmount":{"$ref":"#/components/schemas/RemittanceAmount2"},"creditorReferenceInformation":{"$ref":"#/components/schemas/CreditorReferenceInformation2"},"invoicer":{"$ref":"#/components/schemas/PartyIdentification135"},"invoicee":{"$ref":"#/components/schemas/PartyIdentification135"},"taxRemittance":{"$ref":"#/components/schemas/TaxInformation7"},"garnishmentRemittance":{"$ref":"#/components/schemas/Garnishment3"},"additionalRemittanceInformation":{"maxItems":3,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max140Text"}}}},"SupplementaryData1":{"required":["envelope"],"type":"object","properties":{"placeAndName":{"$ref":"#/components/schemas/Max350Text"},"envelope":{"$ref":"#/components/schemas/SupplementaryDataEnvelope1"}}},"TaxAmount2":{"type":"object","properties":{"rate":{"$ref":"#/components/schemas/PercentageRate"},"taxableBaseAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"totalAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"details":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/TaxRecordDetails2"}}}},"TaxAmountAndType1":{"required":["amount"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/TaxAmountType1Choice"},"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"}}},"TaxAmountType1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalTaxAmountType1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"TaxAuthorisation1":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/Max35Text"},"name":{"$ref":"#/components/schemas/Max140Text"}}},"TaxInformation7":{"type":"object","properties":{"creditor":{"$ref":"#/components/schemas/TaxParty1"},"debtor":{"$ref":"#/components/schemas/TaxParty2"},"ultimateDebtor":{"$ref":"#/components/schemas/TaxParty2"},"administrationZone":{"$ref":"#/components/schemas/Max35Text"},"referenceNumber":{"$ref":"#/components/schemas/Max140Text"},"method":{"$ref":"#/components/schemas/Max35Text"},"totalTaxableBaseAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"totalTaxAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"date":{"$ref":"#/components/schemas/ISODate"},"sequenceNumber":{"$ref":"#/components/schemas/Number"},"record":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/TaxRecord2"}}}},"TaxParty1":{"type":"object","properties":{"taxIdentification":{"$ref":"#/components/schemas/Max35Text"},"registrationIdentification":{"$ref":"#/components/schemas/Max35Text"},"taxType":{"$ref":"#/components/schemas/Max35Text"}}},"TaxParty2":{"type":"object","properties":{"taxIdentification":{"$ref":"#/components/schemas/Max35Text"},"registrationIdentification":{"$ref":"#/components/schemas/Max35Text"},"taxType":{"$ref":"#/components/schemas/Max35Text"},"authorisation":{"$ref":"#/components/schemas/TaxAuthorisation1"}}},"TaxPeriod2":{"type":"object","properties":{"year":{"$ref":"#/components/schemas/ISODate"},"type":{"$ref":"#/components/schemas/TaxRecordPeriod1Code"},"fromToDate":{"$ref":"#/components/schemas/DatePeriod2"}}},"TaxRecord2":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Max35Text"},"category":{"$ref":"#/components/schemas/Max35Text"},"categoryDetails":{"$ref":"#/components/schemas/Max35Text"},"debtorStatus":{"$ref":"#/components/schemas/Max35Text"},"certificateIdentification":{"$ref":"#/components/schemas/Max35Text"},"formsCode":{"$ref":"#/components/schemas/Max35Text"},"period":{"$ref":"#/components/schemas/TaxPeriod2"},"taxAmount":{"$ref":"#/components/schemas/TaxAmount2"},"additionalInformation":{"$ref":"#/components/schemas/Max140Text"}}},"TaxRecordDetails2":{"required":["amount"],"type":"object","properties":{"period":{"$ref":"#/components/schemas/TaxPeriod2"},"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"}}},"ActiveOrHistoricCurrencyAndAmount":{"required":["currency","value"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyCode"},"value":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType"}}},"BatchBookingIndicator":{"type":"boolean"},"SimulationIndicator":{"type":"boolean","default":false},"Authorisation1Code":{"type":"string","enum":["AUTH","FDET","FSUM","ILEV"]},"ChequeDelivery1Code":{"type":"string","enum":["MLDB","MLCD","MLFA","CRDB","CRCD","CRFA","PUDB","PUCD","PUFA","RGDB","RGCD","RGFA"]},"ChequeType2Code":{"type":"string","enum":["CCHQ","CCCH","BCHQ","DRFT","ELDR"]},"ExchangeRateType1Code":{"type":"string","enum":["SPOT","SALE","AGRD"]},"Instruction3Code":{"type":"string","enum":["CHQB","HOLD","PHOB","TELB"]},"PaymentMethod3Code":{"type":"string","enum":["CHK","TRF","TRA"]},"RegulatoryReportingType1Code":{"type":"string","enum":["CRED","DEBT","BOTH"]},"RemittanceLocationMethod2Code":{"type":"string","enum":["FAXI","EDIC","URID","EMAL","POST","SMSM"]},"Max10Text":{"maxLength":10,"minLength":1,"type":"string"},"Authorisation1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/Authorisation1Code"},"proprietary":{"$ref":"#/components/schemas/Max128Text"}}}]},"Cheque11":{"type":"object","properties":{"chequeType":{"$ref":"#/components/schemas/ChequeType2Code"},"chequeNumber":{"$ref":"#/components/schemas/Max35Text"},"chequeFrom":{"$ref":"#/components/schemas/NameAndAddress16"},"deliveryMethod":{"$ref":"#/components/schemas/ChequeDeliveryMethod1Choice"},"deliverTo":{"$ref":"#/components/schemas/NameAndAddress16"},"instructionPriority":{"$ref":"#/components/schemas/Priority2Code"},"chequeMaturityDate":{"$ref":"#/components/schemas/ISODate"},"formsCode":{"$ref":"#/components/schemas/Max35Text"},"memoField":{"maxItems":2,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max35Text"}},"regionalClearingZone":{"$ref":"#/components/schemas/Max35Text"},"printLocation":{"$ref":"#/components/schemas/Max35Text"},"signature":{"maxItems":5,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max70Text"}}}},"ChequeDeliveryMethod1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ChequeDelivery1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"CreditTransferTransaction34":{"required":["amount","paymentIdentification"],"type":"object","properties":{"paymentIdentification":{"$ref":"#/components/schemas/PaymentIdentification6"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation26"},"amount":{"$ref":"#/components/schemas/AmountType4Choice"},"exchangeRateInformation":{"$ref":"#/components/schemas/ExchangeRate1"},"chargeBearer":{"$ref":"#/components/schemas/ChargeBearerType1Code"},"chequeInstruction":{"$ref":"#/components/schemas/Cheque11"},"ultimateDebtor":{"$ref":"#/components/schemas/PartyIdentification135"},"intermediaryAgent1":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"intermediaryAgent1Account":{"$ref":"#/components/schemas/CashAccount38"},"intermediaryAgent2":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"intermediaryAgent2Account":{"$ref":"#/components/schemas/CashAccount38"},"intermediaryAgent3":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"intermediaryAgent3Account":{"$ref":"#/components/schemas/CashAccount38"},"creditorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"creditorAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"creditor":{"$ref":"#/components/schemas/PartyIdentification135"},"creditorAccount":{"$ref":"#/components/schemas/CashAccount38"},"ultimateCreditor":{"$ref":"#/components/schemas/PartyIdentification135"},"instructionForCreditorAgent":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/InstructionForCreditorAgent1"}},"instructionForDebtorAgent":{"$ref":"#/components/schemas/Max140Text"},"purpose":{"$ref":"#/components/schemas/Purpose2Choice"},"regulatoryReporting":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/RegulatoryReporting3"}},"tax":{"$ref":"#/components/schemas/TaxInformation8"},"relatedRemittanceInformation":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/RemittanceLocation7"}},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation16"},"supplementaryData":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/SupplementaryData1"}}}},"CustomerCreditTransferInitiationV09":{"required":["groupHeader","paymentInformation"],"type":"object","properties":{"groupHeader":{"$ref":"#/components/schemas/GroupHeader85"},"paymentInformation":{"maxItems":1,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PaymentInstruction30"}},"supplementaryData":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/SupplementaryData1"}}}},"Pain001":{"required":["customerCreditTransferInitiation"],"type":"object","properties":{"customerCreditTransferInitiation":{"$ref":"#/components/schemas/CustomerCreditTransferInitiationV09"}}},"ExchangeRate1":{"type":"object","properties":{"unitCurrency":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyCode"},"exchangeRate":{"$ref":"#/components/schemas/BaseOneRate"},"rateType":{"$ref":"#/components/schemas/ExchangeRateType1Code"},"contractIdentification":{"$ref":"#/components/schemas/Max35Text"}}},"GroupHeader85":{"required":["creationDateTime","initiatingParty","messageIdentification","numberOfTransactions"],"type":"object","properties":{"messageIdentification":{"$ref":"#/components/schemas/Max35Text"},"creationDateTime":{"$ref":"#/components/schemas/ISODateTime"},"authorisation":{"maxItems":2,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Authorisation1Choice"}},"numberOfTransactions":{"$ref":"#/components/schemas/Max15NumericText"},"controlSum":{"$ref":"#/components/schemas/DecimalNumber"},"initiatingParty":{"$ref":"#/components/schemas/PartyIdentification135"},"forwardingAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"}}},"InstructionForCreditorAgent1":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/Instruction3Code"},"instructionInformation":{"$ref":"#/components/schemas/Max140Text"}}},"NameAndAddress16":{"required":["address","name"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/Max140Text"},"address":{"$ref":"#/components/schemas/PostalAddress24"}}},"PaymentIdentification6":{"required":["endToEndIdentification"],"type":"object","properties":{"instructionIdentification":{"$ref":"#/components/schemas/Max35Text"},"endToEndIdentification":{"$ref":"#/components/schemas/Max35Text"},"UETR":{"$ref":"#/components/schemas/UUIDv4Identifier"}}},"PaymentInstruction30":{"required":["creditTransferTransactionInformation","debtor","debtorAccount","debtorAgent","paymentInformationIdentification","paymentMethod","requestedExecutionDate"],"type":"object","properties":{"paymentInformationIdentification":{"$ref":"#/components/schemas/Max35Text"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod3Code"},"batchBooking":{"$ref":"#/components/schemas/BatchBookingIndicator"},"numberOfTransactions":{"$ref":"#/components/schemas/Max15NumericText"},"controlSum":{"$ref":"#/components/schemas/DecimalNumber"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation26"},"requestedExecutionDate":{"$ref":"#/components/schemas/DateAndDateTime2Choice"},"poolingAdjustmentDate":{"$ref":"#/components/schemas/ISODate"},"debtor":{"$ref":"#/components/schemas/PartyIdentification135"},"debtorAccount":{"$ref":"#/components/schemas/CashAccount38"},"debtorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"debtorAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"instructionForDebtorAgent":{"$ref":"#/components/schemas/Max140Text"},"ultimateDebtor":{"$ref":"#/components/schemas/PartyIdentification135"},"chargeBearer":{"$ref":"#/components/schemas/ChargeBearerType1Code"},"chargesAccount":{"$ref":"#/components/schemas/CashAccount38"},"chargesAccountAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"creditTransferTransactionInformation":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CreditTransferTransaction34"}}}},"PaymentTypeInformation26":{"type":"object","properties":{"instructionPriority":{"$ref":"#/components/schemas/Priority2Code"},"serviceLevel":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ServiceLevel8Choice"}},"localInstrument":{"$ref":"#/components/schemas/LocalInstrument2Choice"},"categoryPurpose":{"$ref":"#/components/schemas/CategoryPurpose1Choice"}}},"RegulatoryAuthority2":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Max140Text"},"country":{"$ref":"#/components/schemas/CountryCode"}}},"RegulatoryReporting3":{"type":"object","properties":{"debitCreditReportingIndicator":{"$ref":"#/components/schemas/RegulatoryReportingType1Code"},"authority":{"$ref":"#/components/schemas/RegulatoryAuthority2"},"details":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/StructuredRegulatoryReporting3"}}}},"RemittanceLocation7":{"type":"object","properties":{"remittanceIdentification":{"$ref":"#/components/schemas/Max35Text"},"remittanceLocationDetails":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/RemittanceLocationData1"}}}},"RemittanceLocationData1":{"required":["method"],"type":"object","properties":{"method":{"$ref":"#/components/schemas/RemittanceLocationMethod2Code"},"electronicAddress":{"$ref":"#/components/schemas/Max2048Text"},"postalAddress":{"$ref":"#/components/schemas/NameAndAddress16"}}},"StructuredRegulatoryReporting3":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Max35Text"},"date":{"$ref":"#/components/schemas/ISODate"},"country":{"$ref":"#/components/schemas/CountryCode"},"code":{"$ref":"#/components/schemas/Max10Text"},"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"information":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max35Text"}}}},"TaxInformation8":{"type":"object","properties":{"creditor":{"$ref":"#/components/schemas/TaxParty1"},"debtor":{"$ref":"#/components/schemas/TaxParty2"},"administrationZone":{"$ref":"#/components/schemas/Max35Text"},"referenceNumber":{"$ref":"#/components/schemas/Max140Text"},"method":{"$ref":"#/components/schemas/Max35Text"},"totalTaxableBaseAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"totalTaxAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"date":{"$ref":"#/components/schemas/ISODate"},"sequenceNumber":{"$ref":"#/components/schemas/Number"},"record":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/TaxRecord2"}}}},"ClearingChannel2Code":{"type":"string","enum":["RTGS","RTNS","MPNS","BOOK"]},"Frequency6Code":{"type":"string","enum":["YEAR","MNTH","QURT","MIAN","WEEK","DAIL","ADHO","INDA","FRTN"]},"PaymentMethod4Code":{"type":"string","enum":["CHK","TRF","DD","TRA"]},"SequenceType3Code":{"type":"string","enum":["FRST","RCUR","FNAL","OOFF","RPRE"]},"SettlementMethod1Code":{"type":"string","enum":["INDA","INGA","COVE","CLRG"]},"ActiveCurrencyAndAmount_SimpleType":{"minimum":0,"exclusiveMinimum":false,"type":"number"},"ActiveCurrencyCode":{"pattern":"[A-Z]{3,3}","type":"string"},"Exact2NumericText":{"pattern":"[0-9]{2}","type":"string"},"ExternalCashClearingSystem1Code":{"maxLength":3,"minLength":1,"type":"string"},"ExternalMandateSetupReason1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalPaymentGroupStatus1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalPaymentTransactionStatus1Code":{"maxLength":4,"minLength":1,"type":"string"},"ExternalStatusReason1Code":{"maxLength":4,"minLength":1,"type":"string"},"Max1025Text":{"maxLength":1025,"minLength":1,"type":"string"},"Max105Text":{"maxLength":105,"minLength":1,"type":"string"},"AmendmentInformationDetails13":{"type":"object","properties":{"originalMandateIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalCreditorSchemeIdentification":{"$ref":"#/components/schemas/PartyIdentification135"},"originalCreditorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"originalCreditorAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"originalDebtor":{"$ref":"#/components/schemas/PartyIdentification135"},"originalDebtorAccount":{"$ref":"#/components/schemas/CashAccount38"},"originalDebtorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"originalDebtorAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"originalFinalCollectionDate":{"$ref":"#/components/schemas/ISODate"},"originalFrequency":{"$ref":"#/components/schemas/Frequency36Choice"},"originalReason":{"$ref":"#/components/schemas/MandateSetupReason1Choice"},"originalTrackingDays":{"$ref":"#/components/schemas/Exact2NumericText"}}},"Charges7":{"required":["agent","amount"],"type":"object","properties":{"amount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"agent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"}}},"ClearingSystemIdentification3Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalCashClearingSystem1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"CurrencyExchange13":{"required":["exchangeRate","sourceCurrency","targetCurrency"],"type":"object","properties":{"sourceCurrency":{"$ref":"#/components/schemas/ActiveCurrencyCode"},"targetCurrency":{"$ref":"#/components/schemas/ActiveCurrencyCode"},"exchangeRate":{"$ref":"#/components/schemas/BaseOneRate"},"unitCurrency":{"$ref":"#/components/schemas/ActiveCurrencyCode"}}},"CustomerPaymentStatusReportV10":{"required":["groupHeader","originalGroupInformationAndStatus"],"type":"object","properties":{"groupHeader":{"$ref":"#/components/schemas/GroupHeader86"},"originalGroupInformationAndStatus":{"$ref":"#/components/schemas/OriginalGroupHeader17"},"originalPaymentInformationAndStatus":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/OriginalPaymentInstruction32"}},"supplementaryData":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/SupplementaryData1"}}}},"Pain002":{"required":["customerPaymentStatusReport"],"type":"object","properties":{"customerPaymentStatusReport":{"$ref":"#/components/schemas/CustomerPaymentStatusReportV10"}}},"Frequency36Choice":{"oneOf":[{"properties":{"type":{"$ref":"#/components/schemas/Frequency6Code"},"period":{"$ref":"#/components/schemas/FrequencyPeriod1"},"pointInTime":{"$ref":"#/components/schemas/FrequencyAndMoment1"}}}]},"FrequencyAndMoment1":{"required":["pointInTime","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/Frequency6Code"},"pointInTime":{"$ref":"#/components/schemas/Exact2NumericText"}}},"FrequencyPeriod1":{"required":["countPerPeriod","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/Frequency6Code"},"countPerPeriod":{"$ref":"#/components/schemas/DecimalNumber"}}},"GroupHeader86":{"required":["creationDateTime","messageIdentification"],"type":"object","properties":{"messageIdentification":{"$ref":"#/components/schemas/Max35Text"},"creationDateTime":{"$ref":"#/components/schemas/ISODateTime"},"initiatingParty":{"$ref":"#/components/schemas/PartyIdentification135"},"forwardingAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"debtorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"creditorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"}}},"MandateRelatedInformation14":{"type":"object","properties":{"mandateIdentification":{"$ref":"#/components/schemas/Max35Text"},"dateOfSignature":{"$ref":"#/components/schemas/ISODate"},"amendmentIndicator":{"$ref":"#/components/schemas/TrueFalseIndicator"},"amendmentInformationDetails":{"$ref":"#/components/schemas/AmendmentInformationDetails13"},"electronicSignature":{"$ref":"#/components/schemas/Max1025Text"},"firstCollectionDate":{"$ref":"#/components/schemas/ISODate"},"finalCollectionDate":{"$ref":"#/components/schemas/ISODate"},"frequency":{"$ref":"#/components/schemas/Frequency36Choice"},"reason":{"$ref":"#/components/schemas/MandateSetupReason1Choice"},"trackingDays":{"$ref":"#/components/schemas/Exact2NumericText"}}},"MandateSetupReason1Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalMandateSetupReason1Code"},"proprietary":{"$ref":"#/components/schemas/Max70Text"}}}]},"NumberOfTransactionsPerStatus5":{"required":["detailedNumberOfTransactions","detailedStatus"],"type":"object","properties":{"detailedNumberOfTransactions":{"$ref":"#/components/schemas/Max15NumericText"},"detailedStatus":{"$ref":"#/components/schemas/ExternalPaymentTransactionStatus1Code"},"detailedControlSum":{"$ref":"#/components/schemas/DecimalNumber"}}},"OriginalGroupHeader17":{"required":["originalMessageIdentification","originalMessageNameIdentification"],"type":"object","properties":{"originalMessageIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalMessageNameIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalCreationDateTime":{"$ref":"#/components/schemas/ISODateTime"},"originalNumberOfTransactions":{"$ref":"#/components/schemas/Max15NumericText"},"originalControlSum":{"$ref":"#/components/schemas/DecimalNumber"},"groupStatus":{"$ref":"#/components/schemas/ExternalPaymentGroupStatus1Code"},"statusReasonInformation":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/StatusReasonInformation12"}},"numberOfTransactionsPerStatus":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/NumberOfTransactionsPerStatus5"}}}},"OriginalPaymentInstruction32":{"required":["originalPaymentInformationIdentification"],"type":"object","properties":{"originalPaymentInformationIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalNumberOfTransactions":{"$ref":"#/components/schemas/Max15NumericText"},"originalControlSum":{"$ref":"#/components/schemas/DecimalNumber"},"paymentInformationStatus":{"$ref":"#/components/schemas/ExternalPaymentGroupStatus1Code"},"statusReasonInformation":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/StatusReasonInformation12"}},"numberOfTransactionsPerStatus":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/NumberOfTransactionsPerStatus5"}},"transactionInformationAndStatus":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/PaymentTransaction105"}}}},"OriginalTransactionReference28":{"type":"object","properties":{"interbankSettlementAmount":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyAndAmount"},"amount":{"$ref":"#/components/schemas/AmountType4Choice"},"interbankSettlementDate":{"$ref":"#/components/schemas/ISODate"},"requestedCollectionDate":{"$ref":"#/components/schemas/ISODate"},"requestedExecutionDate":{"$ref":"#/components/schemas/DateAndDateTime2Choice"},"creditorSchemeIdentification":{"$ref":"#/components/schemas/PartyIdentification135"},"settlementInformation":{"$ref":"#/components/schemas/SettlementInstruction7"},"paymentTypeInformation":{"$ref":"#/components/schemas/PaymentTypeInformation27"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod4Code"},"mandateRelatedInformation":{"$ref":"#/components/schemas/MandateRelatedInformation14"},"remittanceInformation":{"$ref":"#/components/schemas/RemittanceInformation16"},"ultimateDebtor":{"$ref":"#/components/schemas/Party40Choice"},"debtor":{"$ref":"#/components/schemas/Party40Choice"},"debtorAccount":{"$ref":"#/components/schemas/CashAccount38"},"debtorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"debtorAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"creditorAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"creditorAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"creditor":{"$ref":"#/components/schemas/Party40Choice"},"creditorAccount":{"$ref":"#/components/schemas/CashAccount38"},"ultimateCreditor":{"$ref":"#/components/schemas/Party40Choice"},"purpose":{"$ref":"#/components/schemas/Purpose2Choice"}}},"Party40Choice":{"oneOf":[{"properties":{"party":{"$ref":"#/components/schemas/PartyIdentification135"},"agent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"}}}]},"PaymentTransaction105":{"type":"object","properties":{"statusIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalInstructionIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalEndToEndIdentification":{"$ref":"#/components/schemas/Max35Text"},"originalUETR":{"$ref":"#/components/schemas/UUIDv4Identifier"},"transactionStatus":{"$ref":"#/components/schemas/ExternalPaymentTransactionStatus1Code"},"statusReasonInformation":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/StatusReasonInformation12"}},"chargesInformation":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Charges7"}},"trackerData":{"$ref":"#/components/schemas/TrackerData1"},"acceptanceDateTime":{"$ref":"#/components/schemas/ISODateTime"},"accountServicerReference":{"$ref":"#/components/schemas/Max35Text"},"clearingSystemReference":{"$ref":"#/components/schemas/Max35Text"},"originalTransactionReference":{"$ref":"#/components/schemas/OriginalTransactionReference28"},"supplementaryData":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/SupplementaryData1"}}}},"PaymentTypeInformation27":{"type":"object","properties":{"instructionPriority":{"$ref":"#/components/schemas/Priority2Code"},"clearingChannel":{"$ref":"#/components/schemas/ClearingChannel2Code"},"serviceLevel":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ServiceLevel8Choice"}},"localInstrument":{"$ref":"#/components/schemas/LocalInstrument2Choice"},"sequenceType":{"$ref":"#/components/schemas/SequenceType3Code"},"categoryPurpose":{"$ref":"#/components/schemas/CategoryPurpose1Choice"}}},"SettlementInstruction7":{"required":["settlementMethod"],"type":"object","properties":{"settlementMethod":{"$ref":"#/components/schemas/SettlementMethod1Code"},"settlementAccount":{"$ref":"#/components/schemas/CashAccount38"},"clearingSystem":{"$ref":"#/components/schemas/ClearingSystemIdentification3Choice"},"instructingReimbursementAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"instructingReimbursementAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"instructedReimbursementAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"instructedReimbursementAgentAccount":{"$ref":"#/components/schemas/CashAccount38"},"thirdReimbursementAgent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"thirdReimbursementAgentAccount":{"$ref":"#/components/schemas/CashAccount38"}}},"StatusReason6Choice":{"oneOf":[{"properties":{"code":{"$ref":"#/components/schemas/ExternalStatusReason1Code"},"proprietary":{"$ref":"#/components/schemas/Max35Text"}}}]},"StatusReasonInformation12":{"type":"object","properties":{"originator":{"$ref":"#/components/schemas/PartyIdentification135"},"reason":{"$ref":"#/components/schemas/StatusReason6Choice"},"additionalInformation":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Max105Text"}}}},"TrackerData1":{"required":["confirmedAmount","confirmedDate","trackerRecord"],"type":"object","properties":{"confirmedDate":{"$ref":"#/components/schemas/DateAndDateTime2Choice"},"confirmedAmount":{"$ref":"#/components/schemas/ActiveCurrencyAndAmount"},"trackerRecord":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TrackerRecord1"}}}},"TrackerRecord1":{"required":["agent"],"type":"object","properties":{"agent":{"$ref":"#/components/schemas/BranchAndFinancialInstitutionIdentification6"},"chargeBearer":{"$ref":"#/components/schemas/ChargeBearerType1Code"},"chargesAmount":{"$ref":"#/components/schemas/ActiveCurrencyAndAmount"},"exchangeRateData":{"$ref":"#/components/schemas/CurrencyExchange13"}}},"ActiveCurrencyAndAmount":{"required":["currency","value"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/ActiveCurrencyCode"},"value":{"$ref":"#/components/schemas/ActiveCurrencyAndAmount_SimpleType"}}},"SupplementaryDataEnvelope1":{"type":"object"},"ServiceError":{"type":"object","properties":{"code":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"info":{"type":"string"},"message":{"type":"string"},"ref":{"type":"string","format":"uuid"},"status":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"},"params":{"$ref":"#/components/schemas/ValidationError_params"},"additionalProperties":{"type":"string"},"resource":{"type":"string"}}},"BatchClearingResponse":{"type":"object","required":["acceptanceDateTime","executionSystemIdentification","numberOfTransactions","schemeIdentification","simulation","submissionIdentification"],"properties":{"acceptanceDateTime":{"$ref":"#/components/schemas/ISODateTime"},"executionSystemIdentification":{"$ref":"#/components/schemas/Max35Text"},"numberOfTransactions":{"$ref":"#/components/schemas/Max15NumericText"},"schemeIdentification":{"$ref":"#/components/schemas/Max35Text"},"simulation":{"type":"boolean"},"submissionIdentification":{"$ref":"#/components/schemas/Max32Text"}}},"ValidationError_params":{"type":"object","properties":{"additionalProp1":{"type":"string"},"additionalProp2":{"type":"string"},"additionalProp3":{"type":"string"}}}},"examples":{"request_au_becs_ct":{"summary":"A request to initiate a domestic Australian payment","description":"A payment request to initiate a domestic Australian payment with\n* debtor account identification being a subscription key as an internal account identification on the platform (\"INTL\")\n* creditor account identification in BBAN format (BSB + external account number)\n* debtor and creditor agent identification being an Australian BSB (\"AUBSB\")\n* service level set to non-urgent (\"NURG\")\n* instructed amount in Australian Dollars (\\\"AUD\\\")\n* optional supplementary data\n","value":{"customerCreditTransferInitiation":{"groupHeader":{"messageIdentification":"MsgId01","creationDateTime":"2020-01-28T00:51:22.575Z","numberOfTransactions":"1","initiatingParty":{"name":"Allyn Morgen"}},"paymentInformation":[{"paymentInformationIdentification":"PmtInfId01","paymentMethod":"TRF","requestedExecutionDate":{"date":"2020-01-28"},"debtor":{"name":"Allyn Morgen"},"debtorAccount":{"identification":{"other":{"identification":"c5b520dd38464ccf9400f4e32c27fc9","schemeName":{"proprietary":"INTL"}}}},"debtorAgent":{"financialInstitutionIdentification":{"clearingSystemMemberIdentification":{"clearingSystemIdentification":{"code":"AUBSB"},"memberIdentification":"037886"}}},"creditTransferTransactionInformation":[{"paymentIdentification":{"instructionIdentification":"InstrId01","endToEndIdentification":"Lunch"},"paymentTypeInformation":{"serviceLevel":[{"code":"NURG"}]},"amount":{"instructedAmount":{"currency":"AUD","value":47.1}},"creditorAgent":{"financialInstitutionIdentification":{"clearingSystemMemberIdentification":{"clearingSystemIdentification":{"code":"AUBSB"},"memberIdentification":"037886"}}},"creditor":{"name":"Alana Spellard"},"creditorAccount":{"identification":{"other":{"identification":"03788612345678","schemeName":{"code":"BBAN"}}}},"supplementaryData":[{"envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","sequenceType":"FRST"}}]}]}],"supplementaryData":[{"placeAndName":"customerCreditTransferInitiation.paymentInformation[0]","envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","paymentCategory":"EATING_OUT","instructionReceiptIdentification":"ReceiptNumber01"}}]}}},"response_201_rjct":{"summary":"Payment status report with a final status (payment rejected)","description":"A response indicating that the processing of the payment has been completed (HTTP status 201).\n\nAs per the payment status report (pain.002) included in the response the message has been rejected (group status = \"RJCT\") due to an invalid number of transactions on the group level (ISO reason code \"AM19\").\n","value":{"customerPaymentStatusReport":{"groupHeader":{"messageIdentification":"MsgId01","creationDateTime":"2020-01-28T23:28:19.799039Z"},"originalGroupInformationAndStatus":{"originalMessageIdentification":"MsgId01","originalMessageNameIdentification":"pain.001.x01.09","originalCreationDateTime":"2020-01-28T00:51:22.575Z","originalNumberOfTransactions":"2","groupStatus":"RJCT"},"originalPaymentInformationAndStatus":[{"originalPaymentInformationIdentification":"PmtInfId01","paymentInformationStatus":"RJCT","statusReasonInformation":[{"reason":{"proprietary":"TechnicalValidationSucceeded"}},{"reason":{"code":"AM19"},"additionalInformation":["Number of transactions at the group level is invalid or missing"]}],"transactionInformationAndStatus":[{"originalInstructionIdentification":"InstrId01","originalEndToEndIdentification":"Lunch","originalTransactionReference":{"amount":{"instructedAmount":{"currency":"AUD","value":47.1}},"requestedExecutionDate":{"date":"2020-01-28"},"paymentTypeInformation":{"serviceLevel":[{"code":"NURG"}]},"paymentMethod":"TRF","debtor":{"name":"Allyn Morgen"},"debtorAccount":{"identification":{"other":{"identification":"c5b520dd38464ccf9400f4e32c27fc9","schemeName":{"proprietary":"INTL"}}}},"debtorAgent":{"financialInstitutionIdentification":{"clearingSystemMemberIdentification":{"clearingSystemIdentification":{"code":"AUBSB"},"memberIdentification":"037886"}}},"creditor":{"name":"Alana Spellard"},"creditorAccount":{"identification":{"other":{"identification":"03788612345678","schemeName":{"code":"BBAN"}}}},"creditorAgent":{"financialInstitutionIdentification":{"clearingSystemMemberIdentification":{"clearingSystemIdentification":{"code":"AUBSB"},"memberIdentification":"037886"}}}},"supplementaryData":[{"envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","sequenceType":"FRST","transactionTraceIdentification":"fdf76d5a-1f0e-4e52-82a2-8151a20342b0"}}]}]}],"supplementaryData":[{"placeAndName":"customerPaymentStatusReport.originalGroupInformationAndStatus[0]","envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","messageTraceIdentification":"7821c1dd-dd5e-4068-ac17-410e087b30e1"}},{"placeAndName":"customerPaymentStatusReport.originalPaymentInformationAndStatus[0]","envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","instructionReceiptIdentification":"ReceiptNumber01","paymentCategory":"EATING_OUT","instructionTraceIdentification":"3a29d56b-4b78-4d64-9c00-d202103dc4e7"}}]}}},"response_202_accp":{"summary":"Payment status report with a pending status (payment accepted)","description":"A response indicating that the processing of the payment is not yet completed (HTTP status 202).\n\nAs per the payment status report (pain.002) the platform has accepted the request (group status = \"ACCP\").\n","value":{"customerPaymentStatusReport":{"groupHeader":{"messageIdentification":"MsgId01","creationDateTime":"2020-01-28T23:30:28.596502Z"},"originalGroupInformationAndStatus":{"originalMessageIdentification":"MsgId01","originalMessageNameIdentification":"pain.001.x01.09","originalCreationDateTime":"2020-01-28T00:51:22.575Z","originalNumberOfTransactions":"1","groupStatus":"ACCP","statusReasonInformation":[{"reason":{"proprietary":"TechnicalValidationSucceeded"}},{"reason":{"proprietary":"BusinessValidationSucceeded"}}]},"originalPaymentInformationAndStatus":[{"originalPaymentInformationIdentification":"PmtInfId01","paymentInformationStatus":"ACCP","statusReasonInformation":[{"reason":{"proprietary":"BusinessValidationSucceeded"}}],"transactionInformationAndStatus":[{"originalInstructionIdentification":"InstrId01","originalEndToEndIdentification":"Lunch","statusReasonInformation":[{"reason":{"proprietary":"BusinessValidationSucceeded"}},{"reason":{"proprietary":"RoutingDestination"},"additionalInformation":["on-us"]},{"reason":{"proprietary":"SchemeDetermined"},"additionalInformation":["BECS"]}],"originalTransactionReference":{"amount":{"instructedAmount":{"currency":"AUD","value":47.1}},"requestedExecutionDate":{"date":"2020-01-28"},"paymentTypeInformation":{"serviceLevel":[{"code":"NURG"}]},"paymentMethod":"TRF","debtor":{"name":"Allyn Morgen"},"debtorAccount":{"identification":{"other":{"identification":"c5b520dd38464ccf9400f4e32c27fc9","schemeName":{"proprietary":"INTL"}}}},"debtorAgent":{"financialInstitutionIdentification":{"clearingSystemMemberIdentification":{"clearingSystemIdentification":{"code":"AUBSB"},"memberIdentification":"037886"}}},"creditor":{"name":"Alana Spellard"},"creditorAccount":{"identification":{"other":{"identification":"03788612345678","schemeName":{"code":"BBAN"}}}},"creditorAgent":{"financialInstitutionIdentification":{"clearingSystemMemberIdentification":{"clearingSystemIdentification":{"code":"AUBSB"},"memberIdentification":"037886"}}}},"supplementaryData":[{"envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","sequenceType":"FRST","transactionTraceIdentification":"14d21151-2d99-4b88-8a80-85738ca588c9"}}]}]}],"supplementaryData":[{"placeAndName":"customerPaymentStatusReport.originalGroupInformationAndStatus[0]","envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","messageTraceIdentification":"de57c688-07ff-41a0-9e67-b7ea6a90e20e"}},{"placeAndName":"customerPaymentStatusReport.originalPaymentInformationAndStatus[0]","envelope":{"schema":"urn:10x:iso:20022:tech:xsd:supl.001.001.01","instructionReceiptIdentification":"ReceiptNumber01","paymentCategory":"EATING_OUT","instructionTraceIdentification":"6d1971fa-7ab3-4342-9511-ed1928428550"}}]}}},"request_trigger":{"summary":"Trigger DE clearing batch","description":"A request to trigger the creation and submission of all transactions for the scheme \"AU_BECS_CT\" to the execution system \"AU_DE\".","value":{"creationDateTime":"2020-02-04T05:59:35.898Z","schemeIdentification":"AU_BECS_CT","batchLimit":1000,"simulation":false}},"response_trigger_202":{"summary":"Response","description":"A response indicating that the request has been accepted. Includes the number of transactions found for processing.","value":{"acceptanceDateTime":"2020-02-04T05:59:37.023Z","executionSystemIdentification":"AU_DE","schemeIdentification":"AU_BECS_CT","submissionIdentification":"20200204171119","numberOfTransactions":"367","simulation":false}}}}}