> For the complete documentation index, see [llms.txt](https://docs.nexusglobalpayments.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nexusglobalpayments.org/apis/iso-20022-messages.md).

# ISO 20022 Messages

{% hint style="info" %}
ISO 20022 messages are submitted to Nexus via asynchronous API.

The ISO 20022 XML message itself will be included in full in the message body.

The Source IPSO will also define an endpoint to which Nexus should send the resulting response (ie when submitting acmt.023, the Source IPSO must also define the acmt024Endpoint to which Nexus should send the acmt.024 response).
{% endhint %}

## Submit an ISO 20022 pacs.008 FI to FI Customer Credit Transfer

> Submit an ISO 20022 pacs.008 FI to FI customer credit transfer payment instruction. Nexus validates the message, transforms routing fields, and routes it to the Destination IPS. The asynchronous pacs.002 status report is delivered to the Source IPS.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["payment.process"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Pacs008Document":{"type":"object","properties":{"FIToFICstmrCdtTrf":{"$ref":"#/components/schemas/Pacs008FIToFICustomerCreditTransferV13"}},"required":["FIToFICstmrCdtTrf"],"xml":{"name":"Document"}},"Pacs008FIToFICustomerCreditTransferV13":{"type":"object","properties":{"GrpHdr":{"$ref":"#/components/schemas/Pacs008GroupHeader131"},"CdtTrfTxInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008CreditTransferTransaction70"}},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008SupplementaryData1"}}},"required":["GrpHdr","CdtTrfTxInf"]},"Pacs008GroupHeader131":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"},"XpryDtTm":{"type":"string","format":"date-time"},"BtchBookg":{"type":"boolean"},"NbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"CtrlSum":{"type":"number"},"TtlIntrBkSttlmAmt":{"$ref":"#/components/schemas/Pacs008ActiveCurrencyAndAmount"},"IntrBkSttlmDt":{"type":"string","format":"date"},"SttlmInf":{"$ref":"#/components/schemas/Pacs008SettlementInstruction15"},"PmtTpInf":{"$ref":"#/components/schemas/Pacs008PaymentTypeInformation28"},"InstgAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"InstdAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"}},"required":["MsgId","CreDtTm","NbOfTxs","SttlmInf"]},"Pacs008ActiveCurrencyAndAmount":{"type":"object","properties":{"value":{"type":"number","minimum":0},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"}},"required":["value","Ccy"]},"Pacs008SettlementInstruction15":{"type":"object","properties":{"SttlmMtd":{"type":"string","enum":["INDA","INGA","COVE","CLRG"]},"SttlmAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"ClrSys":{"$ref":"#/components/schemas/Pacs008ClearingSystemIdentification3Choice"},"InstgRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"InstgRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"InstdRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"InstdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"ThrdRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"ThrdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"}},"required":["SttlmMtd"]},"Pacs008CashAccount40":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Pacs008AccountIdentification4Choice"},"Tp":{"$ref":"#/components/schemas/Pacs008CashAccountType2Choice"},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"},"Nm":{"type":"string","minLength":1,"maxLength":70},"Prxy":{"$ref":"#/components/schemas/Pacs008ProxyAccountIdentification1"}}},"Pacs008AccountIdentification4Choice":{"type":"object"},"Pacs008CashAccountType2Choice":{"type":"object"},"Pacs008ProxyAccountIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008ProxyAccountType1Choice"},"Id":{"type":"string","minLength":1,"maxLength":2048}},"required":["Id"]},"Pacs008ProxyAccountType1Choice":{"type":"object"},"Pacs008ClearingSystemIdentification3Choice":{"type":"object"},"Pacs008BranchAndFinancialInstitutionIdentification8":{"type":"object","properties":{"FinInstnId":{"$ref":"#/components/schemas/Pacs008FinancialInstitutionIdentification23"},"BrnchId":{"$ref":"#/components/schemas/Pacs008BranchData5"}},"required":["FinInstnId"]},"Pacs008FinancialInstitutionIdentification23":{"type":"object","properties":{"BICFI":{"type":"string","pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"},"ClrSysMmbId":{"$ref":"#/components/schemas/Pacs008ClearingSystemMemberIdentification2"},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs008PostalAddress27"},"Othr":{"$ref":"#/components/schemas/Pacs008GenericFinancialIdentification1"}}},"Pacs008ClearingSystemMemberIdentification2":{"type":"object","properties":{"ClrSysId":{"$ref":"#/components/schemas/Pacs008ClearingSystemIdentification2Choice"},"MmbId":{"type":"string","minLength":1,"maxLength":35}},"required":["MmbId"]},"Pacs008ClearingSystemIdentification2Choice":{"type":"object"},"Pacs008PostalAddress27":{"type":"object","properties":{"AdrTp":{"$ref":"#/components/schemas/Pacs008AddressType3Choice"},"CareOf":{"type":"string","minLength":1,"maxLength":140},"Dept":{"type":"string","minLength":1,"maxLength":70},"SubDept":{"type":"string","minLength":1,"maxLength":70},"StrtNm":{"type":"string","minLength":1,"maxLength":140},"BldgNb":{"type":"string","minLength":1,"maxLength":16},"BldgNm":{"type":"string","minLength":1,"maxLength":140},"Flr":{"type":"string","minLength":1,"maxLength":70},"UnitNb":{"type":"string","minLength":1,"maxLength":16},"PstBx":{"type":"string","minLength":1,"maxLength":16},"Room":{"type":"string","minLength":1,"maxLength":70},"PstCd":{"type":"string","minLength":1,"maxLength":16},"TwnNm":{"type":"string","minLength":1,"maxLength":140},"TwnLctnNm":{"type":"string","minLength":1,"maxLength":140},"DstrctNm":{"type":"string","minLength":1,"maxLength":140},"CtrySubDvsn":{"type":"string","minLength":1,"maxLength":35},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"AdrLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":70}}}},"Pacs008AddressType3Choice":{"type":"object"},"Pacs008GenericFinancialIdentification1":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"SchmeNm":{"$ref":"#/components/schemas/Pacs008FinancialIdentificationSchemeName1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["Id"]},"Pacs008FinancialIdentificationSchemeName1Choice":{"type":"object"},"Pacs008BranchData5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs008PostalAddress27"}}},"Pacs008PaymentTypeInformation28":{"type":"object","properties":{"InstrPrty":{"type":"string","enum":["HIGH","NORM"]},"ClrChanl":{"type":"string","enum":["RTGS","RTNS","MPNS","BOOK"]},"SvcLvl":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008ServiceLevel8Choice"}},"LclInstrm":{"$ref":"#/components/schemas/Pacs008LocalInstrument2Choice"},"CtgyPurp":{"$ref":"#/components/schemas/Pacs008CategoryPurpose1Choice"}}},"Pacs008ServiceLevel8Choice":{"type":"object"},"Pacs008LocalInstrument2Choice":{"type":"object"},"Pacs008CategoryPurpose1Choice":{"type":"object"},"Pacs008CreditTransferTransaction70":{"type":"object","properties":{"PmtId":{"$ref":"#/components/schemas/Pacs008PaymentIdentification13"},"PmtTpInf":{"$ref":"#/components/schemas/Pacs008PaymentTypeInformation28"},"IntrBkSttlmAmt":{"$ref":"#/components/schemas/Pacs008ActiveCurrencyAndAmount"},"IntrBkSttlmDt":{"type":"string","format":"date"},"SttlmPrty":{"type":"string","enum":["URGT","HIGH","NORM"]},"SttlmTmIndctn":{"$ref":"#/components/schemas/Pacs008SettlementDateTimeIndication1"},"SttlmTmReq":{"$ref":"#/components/schemas/Pacs008SettlementTimeRequest2"},"AddtlDtTm":{"$ref":"#/components/schemas/Pacs008AdditionalDateTime1"},"InstdAmt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"XchgRate":{"type":"number"},"AgrdRate":{"$ref":"#/components/schemas/Pacs008CurrencyExchange26"},"ChrgBr":{"type":"string","enum":["DEBT","CRED","SHAR","SLEV"]},"ChrgsInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008Charges16"}},"MndtRltdInf":{"$ref":"#/components/schemas/Pacs008CreditTransferMandateData1"},"PmtSgntr":{"$ref":"#/components/schemas/Pacs008CryptographicKey1Choice"},"PrvsInstgAgt1":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"PrvsInstgAgt1Acct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"PrvsInstgAgt2":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"PrvsInstgAgt2Acct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"PrvsInstgAgt3":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"PrvsInstgAgt3Acct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"InstgAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"InstdAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"IntrmyAgt1":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"IntrmyAgt1Acct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"IntrmyAgt2":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"IntrmyAgt2Acct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"IntrmyAgt3":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"IntrmyAgt3Acct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"UltmtDbtr":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"InitgPty":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"Dbtr":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"DbtrAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"DbtrAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"DbtrAgtAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"CdtrAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"CdtrAgtAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"Cdtr":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"CdtrAcct":{"$ref":"#/components/schemas/Pacs008CashAccount40"},"UltmtCdtr":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"InstrForCdtrAgt":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008InstructionForCreditorAgent3"}},"InstrForNxtAgt":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008InstructionForNextAgent1"}},"Purp":{"$ref":"#/components/schemas/Pacs008Purpose2Choice"},"RgltryRptg":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008RegulatoryReporting3"}},"Tax":{"$ref":"#/components/schemas/Pacs008TaxData1"},"RltdRmtInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008RemittanceLocation8"}},"RmtInf":{"$ref":"#/components/schemas/Pacs008RemittanceInformation22"},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008SupplementaryData1"}}},"required":["PmtId","IntrBkSttlmAmt","ChrgBr","Dbtr","DbtrAgt","CdtrAgt","Cdtr"]},"Pacs008PaymentIdentification13":{"type":"object","properties":{"InstrId":{"type":"string","minLength":1,"maxLength":35},"EndToEndId":{"type":"string","minLength":1,"maxLength":35},"TxId":{"type":"string","minLength":1,"maxLength":35},"UETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"ClrSysRef":{"type":"string","minLength":1,"maxLength":35}},"required":["EndToEndId"]},"Pacs008SettlementDateTimeIndication1":{"type":"object","properties":{"DbtDtTm":{"type":"string","format":"date-time"},"CdtDtTm":{"type":"string","format":"date-time"}}},"Pacs008SettlementTimeRequest2":{"type":"object","properties":{"CLSTm":{"type":"string"},"TillTm":{"type":"string"},"FrTm":{"type":"string"},"RjctTm":{"type":"string"}}},"Pacs008AdditionalDateTime1":{"type":"object","properties":{"AccptncDtTm":{"type":"string","format":"date-time"},"PoolgAdjstmntDt":{"type":"string","format":"date"},"XpryDtTm":{"type":"string","format":"date-time"}}},"Pacs008ActiveOrHistoricCurrencyAndAmount":{"type":"object","properties":{"value":{"type":"number","minimum":0},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"}},"required":["value","Ccy"]},"Pacs008CurrencyExchange26":{"type":"object","properties":{"UnitCcy":{"type":"string","pattern":"[A-Z]{3,3}"},"QtdCcy":{"type":"string","pattern":"[A-Z]{3,3}"},"PreAgrdXchgRate":{"type":"number"},"QtnDtTm":{"type":"string","format":"date-time"},"QtId":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"FXAgt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"}},"required":["PreAgrdXchgRate"]},"Pacs008Charges16":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"Agt":{"$ref":"#/components/schemas/Pacs008BranchAndFinancialInstitutionIdentification8"},"Tp":{"$ref":"#/components/schemas/Pacs008ChargeType3Choice"}},"required":["Amt","Agt"]},"Pacs008ChargeType3Choice":{"type":"object"},"Pacs008CreditTransferMandateData1":{"type":"object","properties":{"MndtId":{"type":"string","minLength":1,"maxLength":35},"Tp":{"$ref":"#/components/schemas/Pacs008MandateTypeInformation2"},"DtOfSgntr":{"type":"string","format":"date"},"DtOfVrfctn":{"type":"string","format":"date-time"},"ElctrncSgntr":{"type":"string","minLength":1,"maxLength":10240},"FrstPmtDt":{"type":"string","format":"date"},"FnlPmtDt":{"type":"string","format":"date"},"Frqcy":{"$ref":"#/components/schemas/Pacs008Frequency36Choice"},"Rsn":{"$ref":"#/components/schemas/Pacs008MandateSetupReason1Choice"}}},"Pacs008MandateTypeInformation2":{"type":"object","properties":{"SvcLvl":{"$ref":"#/components/schemas/Pacs008ServiceLevel8Choice"},"LclInstrm":{"$ref":"#/components/schemas/Pacs008LocalInstrument2Choice"},"CtgyPurp":{"$ref":"#/components/schemas/Pacs008CategoryPurpose1Choice"},"Clssfctn":{"$ref":"#/components/schemas/Pacs008MandateClassification1Choice"}}},"Pacs008MandateClassification1Choice":{"type":"object"},"Pacs008Frequency36Choice":{"type":"object"},"Pacs008MandateSetupReason1Choice":{"type":"object"},"Pacs008CryptographicKey1Choice":{"type":"object"},"Pacs008PartyIdentification272":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs008PostalAddress27"},"Id":{"$ref":"#/components/schemas/Pacs008Party52Choice"},"CtryOfRes":{"type":"string","pattern":"[A-Z]{2,2}"},"CtctDtls":{"$ref":"#/components/schemas/Pacs008Contact13"}}},"Pacs008Party52Choice":{"type":"object"},"Pacs008Contact13":{"type":"object","properties":{"NmPrfx":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"Nm":{"type":"string","minLength":1,"maxLength":140},"PhneNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"MobNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"FaxNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"URLAdr":{"type":"string","minLength":1,"maxLength":2048},"EmailAdr":{"type":"string","minLength":1,"maxLength":256},"EmailPurp":{"type":"string","minLength":1,"maxLength":35},"JobTitl":{"type":"string","minLength":1,"maxLength":35},"Rspnsblty":{"type":"string","minLength":1,"maxLength":35},"Dept":{"type":"string","minLength":1,"maxLength":70},"Othr":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008OtherContact1"}},"PrefrdMtd":{"type":"string","enum":["MAIL","FAXX","LETT","CELL","ONLI","PHON"]}}},"Pacs008OtherContact1":{"type":"object","properties":{"ChanlTp":{"type":"string","minLength":1,"maxLength":4},"Id":{"type":"string","minLength":1,"maxLength":128}},"required":["ChanlTp"]},"Pacs008InstructionForCreditorAgent3":{"type":"object","properties":{"Cd":{"type":"string","minLength":1,"maxLength":4},"InstrInf":{"type":"string","minLength":1,"maxLength":140}}},"Pacs008InstructionForNextAgent1":{"type":"object","properties":{"Cd":{"type":"string","enum":["PHOA","TELA"]},"InstrInf":{"type":"string","minLength":1,"maxLength":140}}},"Pacs008Purpose2Choice":{"type":"object"},"Pacs008RegulatoryReporting3":{"type":"object","properties":{"DbtCdtRptgInd":{"type":"string","enum":["CRED","DEBT","BOTH"]},"Authrty":{"$ref":"#/components/schemas/Pacs008RegulatoryAuthority2"},"Dtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008StructuredRegulatoryReporting3"}}}},"Pacs008RegulatoryAuthority2":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"}}},"Pacs008StructuredRegulatoryReporting3":{"type":"object","properties":{"Tp":{"type":"string","minLength":1,"maxLength":35},"Dt":{"type":"string","format":"date"},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"Cd":{"type":"string","minLength":1,"maxLength":10},"Amt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"Inf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":35}}}},"Pacs008TaxData1":{"type":"object","properties":{"Cdtr":{"$ref":"#/components/schemas/Pacs008TaxParty1"},"Dbtr":{"$ref":"#/components/schemas/Pacs008TaxParty2"},"UltmtDbtr":{"$ref":"#/components/schemas/Pacs008TaxParty2"},"AdmstnZone":{"type":"string","minLength":1,"maxLength":35},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Mtd":{"type":"string","minLength":1,"maxLength":35},"TtlTaxblBaseAmt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"TtlTaxAmt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"Dt":{"type":"string","format":"date"},"SeqNb":{"type":"number"},"Rcrd":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008TaxRecord3"}}}},"Pacs008TaxParty1":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35}}},"Pacs008TaxParty2":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35},"Authstn":{"$ref":"#/components/schemas/Pacs008TaxAuthorisation1"}}},"Pacs008TaxAuthorisation1":{"type":"object","properties":{"Titl":{"type":"string","minLength":1,"maxLength":35},"Nm":{"type":"string","minLength":1,"maxLength":140}}},"Pacs008TaxRecord3":{"type":"object","properties":{"Tp":{"type":"string","minLength":1,"maxLength":35},"Ctgy":{"type":"string","minLength":1,"maxLength":35},"CtgyDtls":{"type":"string","minLength":1,"maxLength":35},"DbtrSts":{"type":"string","minLength":1,"maxLength":35},"CertId":{"type":"string","minLength":1,"maxLength":35},"FrmsCd":{"type":"string","minLength":1,"maxLength":35},"Prd":{"$ref":"#/components/schemas/Pacs008TaxPeriod3"},"TaxAmt":{"$ref":"#/components/schemas/Pacs008TaxAmount3"},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}}},"Pacs008TaxPeriod3":{"type":"object","properties":{"Yr":{"type":"string"},"Tp":{"type":"string","enum":["MM01","MM02","MM03","MM04","MM05","MM06","MM07","MM08","MM09","MM10","MM11","MM12","QTR1","QTR2","QTR3","QTR4","HLF1","HLF2"]},"FrToDt":{"$ref":"#/components/schemas/Pacs008DatePeriod2"}}},"Pacs008DatePeriod2":{"type":"object","properties":{"FrDt":{"type":"string","format":"date"},"ToDt":{"type":"string","format":"date"}},"required":["FrDt","ToDt"]},"Pacs008TaxAmount3":{"type":"object","properties":{"Rate":{"type":"number"},"TaxblBaseAmt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"TtlAmt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"Dtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008TaxRecordDetails3"}}}},"Pacs008TaxRecordDetails3":{"type":"object","properties":{"Prd":{"$ref":"#/components/schemas/Pacs008TaxPeriod3"},"Amt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"}},"required":["Amt"]},"Pacs008RemittanceLocation8":{"type":"object","properties":{"RmtId":{"type":"string","minLength":1,"maxLength":35},"RmtLctnDtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008RemittanceLocationData2"}}}},"Pacs008RemittanceLocationData2":{"type":"object","properties":{"Mtd":{"type":"string","enum":["FAXI","EDIC","URID","EMAL","POST","SMSM"]},"ElctrncAdr":{"type":"string","minLength":1,"maxLength":2048},"PstlAdr":{"$ref":"#/components/schemas/Pacs008NameAndAddress18"}},"required":["Mtd"]},"Pacs008NameAndAddress18":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"Adr":{"$ref":"#/components/schemas/Pacs008PostalAddress27"}},"required":["Nm","Adr"]},"Pacs008RemittanceInformation22":{"type":"object","properties":{"Ustrd":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"Strd":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008StructuredRemittanceInformation18"}}}},"Pacs008StructuredRemittanceInformation18":{"type":"object","properties":{"RfrdDocInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008ReferredDocumentInformation8"}},"RfrdDocAmt":{"$ref":"#/components/schemas/Pacs008RemittanceAmount4"},"CdtrRefInf":{"$ref":"#/components/schemas/Pacs008CreditorReferenceInformation3"},"Invcr":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"Invcee":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"TaxRmt":{"$ref":"#/components/schemas/Pacs008TaxData1"},"GrnshmtRmt":{"$ref":"#/components/schemas/Pacs008Garnishment4"},"AddtlRmtInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}}}},"Pacs008ReferredDocumentInformation8":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008DocumentType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"$ref":"#/components/schemas/Pacs008DateAndType1"},"LineDtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008DocumentLineInformation2"}}}},"Pacs008DocumentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs008DocumentType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs008DocumentType2Choice":{"type":"object"},"Pacs008DateAndType1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008DateType2Choice"},"Dt":{"type":"string","format":"date"}},"required":["Tp","Dt"]},"Pacs008DateType2Choice":{"type":"object"},"Pacs008DocumentLineInformation2":{"type":"object","properties":{"Id":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008DocumentLineIdentification1"}},"Desc":{"type":"string","minLength":1,"maxLength":2048},"Amt":{"$ref":"#/components/schemas/Pacs008RemittanceAmount4"}},"required":["Id"]},"Pacs008DocumentLineIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008DocumentLineType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"type":"string","format":"date"}}},"Pacs008DocumentLineType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs008DocumentLineType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs008DocumentLineType1Choice":{"type":"object"},"Pacs008RemittanceAmount4":{"type":"object","properties":{"RmtAmtAndTp":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008DocumentAmount1"}},"AdjstmntAmtAndRsn":{"type":"array","items":{"$ref":"#/components/schemas/Pacs008DocumentAdjustment1"}}}},"Pacs008DocumentAmount1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008DocumentAmountType1Choice"},"Amt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"}},"required":["Tp","Amt"]},"Pacs008DocumentAmountType1Choice":{"type":"object"},"Pacs008DocumentAdjustment1":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"CdtDbtInd":{"type":"string","enum":["CRDT","DBIT"]},"Rsn":{"type":"string","minLength":1,"maxLength":4},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}},"required":["Amt"]},"Pacs008CreditorReferenceInformation3":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008CreditorReferenceType3"},"Ref":{"type":"string","minLength":1,"maxLength":35}}},"Pacs008CreditorReferenceType3":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs008CreditorReferenceType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs008CreditorReferenceType2Choice":{"type":"object"},"Pacs008Garnishment4":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs008GarnishmentType1"},"Grnshee":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"GrnshmtAdmstr":{"$ref":"#/components/schemas/Pacs008PartyIdentification272"},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Dt":{"type":"string","format":"date"},"RmtdAmt":{"$ref":"#/components/schemas/Pacs008ActiveOrHistoricCurrencyAndAmount"},"FmlyMdclInsrncInd":{"type":"boolean"},"MplyeeTermntnInd":{"type":"boolean"}},"required":["Tp"]},"Pacs008GarnishmentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs008GarnishmentType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs008GarnishmentType1Choice":{"type":"object"},"Pacs008SupplementaryData1":{"type":"object","properties":{"PlcAndNm":{"type":"string","minLength":1,"maxLength":350},"Envlp":{"$ref":"#/components/schemas/Pacs008SupplementaryDataEnvelope1"}},"required":["Envlp"]},"Pacs008SupplementaryDataEnvelope1":{"type":"object"},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/pacs008":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 pacs.008 FI to FI Customer Credit Transfer","description":"Submit an ISO 20022 pacs.008 FI to FI customer credit transfer payment instruction. Nexus validates the message, transforms routing fields, and routes it to the Destination IPS. The asynchronous pacs.002 status report is delivered to the Source IPS.","operationId":"submitPacs008","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 pacs.008.001.13 XML payload. Validated against the pacs.008.001.13 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Pacs008Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002, negative pacs.002)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"409":{"description":"Conflict. This request was already accepted and is still being processed. Do not retry - use a pacs.028 status request to check the outcome."},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```

## Submit an ISO 20022 pacs.002 FI to FI Payment Status Report

> Submit an ISO 20022 pacs.002 FI to FI payment status report. Nexus validates the status report, correlates it to the original pacs.008 by OrgnlUETR, and routes it to the Source IPS for that transaction.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["payment.process"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Pacs002Document":{"type":"object","properties":{"FIToFIPmtStsRpt":{"$ref":"#/components/schemas/Pacs002FIToFIPaymentStatusReportV15"}},"required":["FIToFIPmtStsRpt"],"xml":{"name":"Document"}},"Pacs002FIToFIPaymentStatusReportV15":{"type":"object","properties":{"GrpHdr":{"$ref":"#/components/schemas/Pacs002GroupHeader120"},"OrgnlGrpInfAndSts":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002OriginalGroupHeader22"}},"TxInfAndSts":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002PaymentTransaction164"}},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002SupplementaryData1"}}},"required":["GrpHdr"]},"Pacs002GroupHeader120":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"},"InstgAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"InstdAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"OrgnlBizQry":{"$ref":"#/components/schemas/Pacs002OriginalBusinessQuery1"}},"required":["MsgId","CreDtTm"]},"Pacs002BranchAndFinancialInstitutionIdentification8":{"type":"object","properties":{"FinInstnId":{"$ref":"#/components/schemas/Pacs002FinancialInstitutionIdentification23"},"BrnchId":{"$ref":"#/components/schemas/Pacs002BranchData5"}},"required":["FinInstnId"]},"Pacs002FinancialInstitutionIdentification23":{"type":"object","properties":{"BICFI":{"type":"string","pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"},"ClrSysMmbId":{"$ref":"#/components/schemas/Pacs002ClearingSystemMemberIdentification2"},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs002PostalAddress27"},"Othr":{"$ref":"#/components/schemas/Pacs002GenericFinancialIdentification1"}}},"Pacs002ClearingSystemMemberIdentification2":{"type":"object","properties":{"ClrSysId":{"$ref":"#/components/schemas/Pacs002ClearingSystemIdentification2Choice"},"MmbId":{"type":"string","minLength":1,"maxLength":35}},"required":["MmbId"]},"Pacs002ClearingSystemIdentification2Choice":{"type":"object"},"Pacs002PostalAddress27":{"type":"object","properties":{"AdrTp":{"$ref":"#/components/schemas/Pacs002AddressType3Choice"},"CareOf":{"type":"string","minLength":1,"maxLength":140},"Dept":{"type":"string","minLength":1,"maxLength":70},"SubDept":{"type":"string","minLength":1,"maxLength":70},"StrtNm":{"type":"string","minLength":1,"maxLength":140},"BldgNb":{"type":"string","minLength":1,"maxLength":16},"BldgNm":{"type":"string","minLength":1,"maxLength":140},"Flr":{"type":"string","minLength":1,"maxLength":70},"UnitNb":{"type":"string","minLength":1,"maxLength":16},"PstBx":{"type":"string","minLength":1,"maxLength":16},"Room":{"type":"string","minLength":1,"maxLength":70},"PstCd":{"type":"string","minLength":1,"maxLength":16},"TwnNm":{"type":"string","minLength":1,"maxLength":140},"TwnLctnNm":{"type":"string","minLength":1,"maxLength":140},"DstrctNm":{"type":"string","minLength":1,"maxLength":140},"CtrySubDvsn":{"type":"string","minLength":1,"maxLength":35},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"AdrLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":70}}}},"Pacs002AddressType3Choice":{"type":"object"},"Pacs002GenericFinancialIdentification1":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"SchmeNm":{"$ref":"#/components/schemas/Pacs002FinancialIdentificationSchemeName1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["Id"]},"Pacs002FinancialIdentificationSchemeName1Choice":{"type":"object"},"Pacs002BranchData5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs002PostalAddress27"}}},"Pacs002OriginalBusinessQuery1":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"MsgNmId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"}},"required":["MsgId"]},"Pacs002OriginalGroupHeader22":{"type":"object","properties":{"OrgnlMsgId":{"type":"string","minLength":1,"maxLength":35},"OrgnlMsgNmId":{"type":"string","minLength":1,"maxLength":35},"OrgnlCreDtTm":{"type":"string","format":"date-time"},"OrgnlNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"OrgnlCtrlSum":{"type":"number"},"GrpSts":{"type":"string","minLength":1,"maxLength":4},"StsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002StatusReasonInformation14"}},"NbOfTxsPerSts":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002NumberOfTransactionsPerStatus5"}}},"required":["OrgnlMsgId","OrgnlMsgNmId"]},"Pacs002StatusReasonInformation14":{"type":"object","properties":{"Orgtr":{"$ref":"#/components/schemas/Pacs002PartyIdentification272"},"Rsn":{"$ref":"#/components/schemas/Pacs002StatusReason6Choice"},"AddtlInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":105}}}},"Pacs002PartyIdentification272":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs002PostalAddress27"},"Id":{"$ref":"#/components/schemas/Pacs002Party52Choice"},"CtryOfRes":{"type":"string","pattern":"[A-Z]{2,2}"},"CtctDtls":{"$ref":"#/components/schemas/Pacs002Contact13"}}},"Pacs002Party52Choice":{"type":"object"},"Pacs002Contact13":{"type":"object","properties":{"NmPrfx":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"Nm":{"type":"string","minLength":1,"maxLength":140},"PhneNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"MobNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"FaxNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"URLAdr":{"type":"string","minLength":1,"maxLength":2048},"EmailAdr":{"type":"string","minLength":1,"maxLength":256},"EmailPurp":{"type":"string","minLength":1,"maxLength":35},"JobTitl":{"type":"string","minLength":1,"maxLength":35},"Rspnsblty":{"type":"string","minLength":1,"maxLength":35},"Dept":{"type":"string","minLength":1,"maxLength":70},"Othr":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002OtherContact1"}},"PrefrdMtd":{"type":"string","enum":["MAIL","FAXX","LETT","CELL","ONLI","PHON"]}}},"Pacs002OtherContact1":{"type":"object","properties":{"ChanlTp":{"type":"string","minLength":1,"maxLength":4},"Id":{"type":"string","minLength":1,"maxLength":128}},"required":["ChanlTp"]},"Pacs002StatusReason6Choice":{"type":"object"},"Pacs002NumberOfTransactionsPerStatus5":{"type":"object","properties":{"DtldNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"DtldSts":{"type":"string","minLength":1,"maxLength":4},"DtldCtrlSum":{"type":"number"}},"required":["DtldNbOfTxs","DtldSts"]},"Pacs002PaymentTransaction164":{"type":"object","properties":{"StsId":{"type":"string","minLength":1,"maxLength":35},"OrgnlGrpInf":{"$ref":"#/components/schemas/Pacs002OriginalGroupInformation29"},"OrgnlInstrId":{"type":"string","minLength":1,"maxLength":35},"OrgnlEndToEndId":{"type":"string","minLength":1,"maxLength":35},"OrgnlTxId":{"type":"string","minLength":1,"maxLength":35},"OrgnlUETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"TxSts":{"type":"string","minLength":1,"maxLength":4},"StsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002StatusReasonInformation14"}},"ChrgsInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002Charges16"}},"AccptncDtTm":{"type":"string","format":"date-time"},"PrcgDt":{"$ref":"#/components/schemas/Pacs002DateAndDateTime2Choice"},"FctvIntrBkSttlmDt":{"$ref":"#/components/schemas/Pacs002DateAndDateTime2Choice"},"AcctSvcrRef":{"type":"string","minLength":1,"maxLength":35},"ClrSysRef":{"type":"string","minLength":1,"maxLength":35},"CdtSttlmKey":{"type":"string","pattern":"([0-9A-F][0-9A-F]){32}"},"InstgAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"InstdAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"OrgnlTxRef":{"$ref":"#/components/schemas/Pacs002OriginalTransactionReference42"},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002SupplementaryData1"}}}},"Pacs002OriginalGroupInformation29":{"type":"object","properties":{"OrgnlMsgId":{"type":"string","minLength":1,"maxLength":35},"OrgnlMsgNmId":{"type":"string","minLength":1,"maxLength":35},"OrgnlCreDtTm":{"type":"string","format":"date-time"}},"required":["OrgnlMsgId","OrgnlMsgNmId"]},"Pacs002Charges16":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"Agt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"Tp":{"$ref":"#/components/schemas/Pacs002ChargeType3Choice"}},"required":["Amt","Agt"]},"Pacs002ActiveOrHistoricCurrencyAndAmount":{"type":"object","properties":{"value":{"type":"number","minimum":0},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"}},"required":["value","Ccy"]},"Pacs002ChargeType3Choice":{"type":"object"},"Pacs002DateAndDateTime2Choice":{"type":"object"},"Pacs002OriginalTransactionReference42":{"type":"object","properties":{"IntrBkSttlmAmt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"Amt":{"$ref":"#/components/schemas/Pacs002AmountType4Choice"},"IntrBkSttlmDt":{"type":"string","format":"date"},"ReqdColltnDt":{"type":"string","format":"date"},"ReqdExctnDt":{"$ref":"#/components/schemas/Pacs002DateAndDateTime2Choice"},"CdtrSchmeId":{"$ref":"#/components/schemas/Pacs002PartyIdentification272"},"SttlmInf":{"$ref":"#/components/schemas/Pacs002SettlementInstruction15"},"PmtTpInf":{"$ref":"#/components/schemas/Pacs002PaymentTypeInformation27"},"PmtMtd":{"type":"string","enum":["CHK","TRF","DD","TRA"]},"MndtRltdInf":{"$ref":"#/components/schemas/Pacs002MandateRelatedData3Choice"},"RmtInf":{"$ref":"#/components/schemas/Pacs002RemittanceInformation22"},"UltmtDbtr":{"$ref":"#/components/schemas/Pacs002Party50Choice"},"Dbtr":{"$ref":"#/components/schemas/Pacs002Party50Choice"},"DbtrAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"DbtrAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"DbtrAgtAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"CdtrAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"CdtrAgtAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"Cdtr":{"$ref":"#/components/schemas/Pacs002Party50Choice"},"CdtrAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"UltmtCdtr":{"$ref":"#/components/schemas/Pacs002Party50Choice"},"Purp":{"$ref":"#/components/schemas/Pacs002Purpose2Choice"}}},"Pacs002AmountType4Choice":{"type":"object"},"Pacs002SettlementInstruction15":{"type":"object","properties":{"SttlmMtd":{"type":"string","enum":["INDA","INGA","COVE","CLRG"]},"SttlmAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"ClrSys":{"$ref":"#/components/schemas/Pacs002ClearingSystemIdentification3Choice"},"InstgRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"InstgRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"InstdRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"InstdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"},"ThrdRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs002BranchAndFinancialInstitutionIdentification8"},"ThrdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs002CashAccount40"}},"required":["SttlmMtd"]},"Pacs002CashAccount40":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Pacs002AccountIdentification4Choice"},"Tp":{"$ref":"#/components/schemas/Pacs002CashAccountType2Choice"},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"},"Nm":{"type":"string","minLength":1,"maxLength":70},"Prxy":{"$ref":"#/components/schemas/Pacs002ProxyAccountIdentification1"}}},"Pacs002AccountIdentification4Choice":{"type":"object"},"Pacs002CashAccountType2Choice":{"type":"object"},"Pacs002ProxyAccountIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002ProxyAccountType1Choice"},"Id":{"type":"string","minLength":1,"maxLength":2048}},"required":["Id"]},"Pacs002ProxyAccountType1Choice":{"type":"object"},"Pacs002ClearingSystemIdentification3Choice":{"type":"object"},"Pacs002PaymentTypeInformation27":{"type":"object","properties":{"InstrPrty":{"type":"string","enum":["HIGH","NORM"]},"ClrChanl":{"type":"string","enum":["RTGS","RTNS","MPNS","BOOK"]},"SvcLvl":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002ServiceLevel8Choice"}},"LclInstrm":{"$ref":"#/components/schemas/Pacs002LocalInstrument2Choice"},"SeqTp":{"type":"string","enum":["FRST","RCUR","FNAL","OOFF","RPRE"]},"CtgyPurp":{"$ref":"#/components/schemas/Pacs002CategoryPurpose1Choice"}}},"Pacs002ServiceLevel8Choice":{"type":"object"},"Pacs002LocalInstrument2Choice":{"type":"object"},"Pacs002CategoryPurpose1Choice":{"type":"object"},"Pacs002MandateRelatedData3Choice":{"type":"object"},"Pacs002RemittanceInformation22":{"type":"object","properties":{"Ustrd":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"Strd":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002StructuredRemittanceInformation18"}}}},"Pacs002StructuredRemittanceInformation18":{"type":"object","properties":{"RfrdDocInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002ReferredDocumentInformation8"}},"RfrdDocAmt":{"$ref":"#/components/schemas/Pacs002RemittanceAmount4"},"CdtrRefInf":{"$ref":"#/components/schemas/Pacs002CreditorReferenceInformation3"},"Invcr":{"$ref":"#/components/schemas/Pacs002PartyIdentification272"},"Invcee":{"$ref":"#/components/schemas/Pacs002PartyIdentification272"},"TaxRmt":{"$ref":"#/components/schemas/Pacs002TaxData1"},"GrnshmtRmt":{"$ref":"#/components/schemas/Pacs002Garnishment4"},"AddtlRmtInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}}}},"Pacs002ReferredDocumentInformation8":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002DocumentType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"$ref":"#/components/schemas/Pacs002DateAndType1"},"LineDtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002DocumentLineInformation2"}}}},"Pacs002DocumentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs002DocumentType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs002DocumentType2Choice":{"type":"object"},"Pacs002DateAndType1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002DateType2Choice"},"Dt":{"type":"string","format":"date"}},"required":["Tp","Dt"]},"Pacs002DateType2Choice":{"type":"object"},"Pacs002DocumentLineInformation2":{"type":"object","properties":{"Id":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002DocumentLineIdentification1"}},"Desc":{"type":"string","minLength":1,"maxLength":2048},"Amt":{"$ref":"#/components/schemas/Pacs002RemittanceAmount4"}},"required":["Id"]},"Pacs002DocumentLineIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002DocumentLineType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"type":"string","format":"date"}}},"Pacs002DocumentLineType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs002DocumentLineType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs002DocumentLineType1Choice":{"type":"object"},"Pacs002RemittanceAmount4":{"type":"object","properties":{"RmtAmtAndTp":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002DocumentAmount1"}},"AdjstmntAmtAndRsn":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002DocumentAdjustment1"}}}},"Pacs002DocumentAmount1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002DocumentAmountType1Choice"},"Amt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"}},"required":["Tp","Amt"]},"Pacs002DocumentAmountType1Choice":{"type":"object"},"Pacs002DocumentAdjustment1":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"CdtDbtInd":{"type":"string","enum":["CRDT","DBIT"]},"Rsn":{"type":"string","minLength":1,"maxLength":4},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}},"required":["Amt"]},"Pacs002CreditorReferenceInformation3":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002CreditorReferenceType3"},"Ref":{"type":"string","minLength":1,"maxLength":35}}},"Pacs002CreditorReferenceType3":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs002CreditorReferenceType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs002CreditorReferenceType2Choice":{"type":"object"},"Pacs002TaxData1":{"type":"object","properties":{"Cdtr":{"$ref":"#/components/schemas/Pacs002TaxParty1"},"Dbtr":{"$ref":"#/components/schemas/Pacs002TaxParty2"},"UltmtDbtr":{"$ref":"#/components/schemas/Pacs002TaxParty2"},"AdmstnZone":{"type":"string","minLength":1,"maxLength":35},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Mtd":{"type":"string","minLength":1,"maxLength":35},"TtlTaxblBaseAmt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"TtlTaxAmt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"Dt":{"type":"string","format":"date"},"SeqNb":{"type":"number"},"Rcrd":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002TaxRecord3"}}}},"Pacs002TaxParty1":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35}}},"Pacs002TaxParty2":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35},"Authstn":{"$ref":"#/components/schemas/Pacs002TaxAuthorisation1"}}},"Pacs002TaxAuthorisation1":{"type":"object","properties":{"Titl":{"type":"string","minLength":1,"maxLength":35},"Nm":{"type":"string","minLength":1,"maxLength":140}}},"Pacs002TaxRecord3":{"type":"object","properties":{"Tp":{"type":"string","minLength":1,"maxLength":35},"Ctgy":{"type":"string","minLength":1,"maxLength":35},"CtgyDtls":{"type":"string","minLength":1,"maxLength":35},"DbtrSts":{"type":"string","minLength":1,"maxLength":35},"CertId":{"type":"string","minLength":1,"maxLength":35},"FrmsCd":{"type":"string","minLength":1,"maxLength":35},"Prd":{"$ref":"#/components/schemas/Pacs002TaxPeriod3"},"TaxAmt":{"$ref":"#/components/schemas/Pacs002TaxAmount3"},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}}},"Pacs002TaxPeriod3":{"type":"object","properties":{"Yr":{"type":"string"},"Tp":{"type":"string","enum":["MM01","MM02","MM03","MM04","MM05","MM06","MM07","MM08","MM09","MM10","MM11","MM12","QTR1","QTR2","QTR3","QTR4","HLF1","HLF2"]},"FrToDt":{"$ref":"#/components/schemas/Pacs002DatePeriod2"}}},"Pacs002DatePeriod2":{"type":"object","properties":{"FrDt":{"type":"string","format":"date"},"ToDt":{"type":"string","format":"date"}},"required":["FrDt","ToDt"]},"Pacs002TaxAmount3":{"type":"object","properties":{"Rate":{"type":"number"},"TaxblBaseAmt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"TtlAmt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"Dtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs002TaxRecordDetails3"}}}},"Pacs002TaxRecordDetails3":{"type":"object","properties":{"Prd":{"$ref":"#/components/schemas/Pacs002TaxPeriod3"},"Amt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"}},"required":["Amt"]},"Pacs002Garnishment4":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs002GarnishmentType1"},"Grnshee":{"$ref":"#/components/schemas/Pacs002PartyIdentification272"},"GrnshmtAdmstr":{"$ref":"#/components/schemas/Pacs002PartyIdentification272"},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Dt":{"type":"string","format":"date"},"RmtdAmt":{"$ref":"#/components/schemas/Pacs002ActiveOrHistoricCurrencyAndAmount"},"FmlyMdclInsrncInd":{"type":"boolean"},"MplyeeTermntnInd":{"type":"boolean"}},"required":["Tp"]},"Pacs002GarnishmentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs002GarnishmentType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs002GarnishmentType1Choice":{"type":"object"},"Pacs002Party50Choice":{"type":"object"},"Pacs002Purpose2Choice":{"type":"object"},"Pacs002SupplementaryData1":{"type":"object","properties":{"PlcAndNm":{"type":"string","minLength":1,"maxLength":350},"Envlp":{"$ref":"#/components/schemas/Pacs002SupplementaryDataEnvelope1"}},"required":["Envlp"]},"Pacs002SupplementaryDataEnvelope1":{"type":"object"},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/pacs002":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 pacs.002 FI to FI Payment Status Report","description":"Submit an ISO 20022 pacs.002 FI to FI payment status report. Nexus validates the status report, correlates it to the original pacs.008 by OrgnlUETR, and routes it to the Source IPS for that transaction.","operationId":"submitPacs002","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 pacs.002.001.15 XML payload. Validated against the pacs.002.001.15 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Pacs002Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"409":{"description":"Conflict. This request was already accepted and is still being processed. Do not retry - use a pacs.028 status request to check the outcome."},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```

## Submit an ISO 20022 acmt.023 Identification Verification Request

> Submit an ISO 20022 acmt.023 identification verification request. Nexus validates, transforms, and routes the message to the Destination IPS. The asynchronous acmt.024 outcome is delivered to the Source IPS.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["payment.process"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Acmt023Document":{"type":"object","properties":{"IdVrfctnReq":{"$ref":"#/components/schemas/Acmt023IdentificationVerificationRequestV04"}},"required":["IdVrfctnReq"],"xml":{"name":"Document"}},"Acmt023IdentificationVerificationRequestV04":{"type":"object","properties":{"Assgnmt":{"$ref":"#/components/schemas/Acmt023IdentificationAssignment4"},"Vrfctn":{"type":"array","items":{"$ref":"#/components/schemas/Acmt023IdentificationVerification5"}},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Acmt023SupplementaryData1"}}},"required":["Assgnmt","Vrfctn"]},"Acmt023IdentificationAssignment4":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"},"Cretr":{"$ref":"#/components/schemas/Acmt023Party50Choice"},"FrstAgt":{"$ref":"#/components/schemas/Acmt023BranchAndFinancialInstitutionIdentification8"},"Assgnr":{"$ref":"#/components/schemas/Acmt023Party50Choice"},"Assgne":{"$ref":"#/components/schemas/Acmt023Party50Choice"}},"required":["MsgId","CreDtTm","Assgnr","Assgne"]},"Acmt023Party50Choice":{"type":"object"},"Acmt023BranchAndFinancialInstitutionIdentification8":{"type":"object","properties":{"FinInstnId":{"$ref":"#/components/schemas/Acmt023FinancialInstitutionIdentification23"},"BrnchId":{"$ref":"#/components/schemas/Acmt023BranchData5"}},"required":["FinInstnId"]},"Acmt023FinancialInstitutionIdentification23":{"type":"object","properties":{"BICFI":{"type":"string","pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"},"ClrSysMmbId":{"$ref":"#/components/schemas/Acmt023ClearingSystemMemberIdentification2"},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Acmt023PostalAddress27"},"Othr":{"$ref":"#/components/schemas/Acmt023GenericFinancialIdentification1"}}},"Acmt023ClearingSystemMemberIdentification2":{"type":"object","properties":{"ClrSysId":{"$ref":"#/components/schemas/Acmt023ClearingSystemIdentification2Choice"},"MmbId":{"type":"string","minLength":1,"maxLength":35}},"required":["MmbId"]},"Acmt023ClearingSystemIdentification2Choice":{"type":"object"},"Acmt023PostalAddress27":{"type":"object","properties":{"AdrTp":{"$ref":"#/components/schemas/Acmt023AddressType3Choice"},"CareOf":{"type":"string","minLength":1,"maxLength":140},"Dept":{"type":"string","minLength":1,"maxLength":70},"SubDept":{"type":"string","minLength":1,"maxLength":70},"StrtNm":{"type":"string","minLength":1,"maxLength":140},"BldgNb":{"type":"string","minLength":1,"maxLength":16},"BldgNm":{"type":"string","minLength":1,"maxLength":140},"Flr":{"type":"string","minLength":1,"maxLength":70},"UnitNb":{"type":"string","minLength":1,"maxLength":16},"PstBx":{"type":"string","minLength":1,"maxLength":16},"Room":{"type":"string","minLength":1,"maxLength":70},"PstCd":{"type":"string","minLength":1,"maxLength":16},"TwnNm":{"type":"string","minLength":1,"maxLength":140},"TwnLctnNm":{"type":"string","minLength":1,"maxLength":140},"DstrctNm":{"type":"string","minLength":1,"maxLength":140},"CtrySubDvsn":{"type":"string","minLength":1,"maxLength":35},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"AdrLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":70}}}},"Acmt023AddressType3Choice":{"type":"object"},"Acmt023GenericFinancialIdentification1":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"SchmeNm":{"$ref":"#/components/schemas/Acmt023FinancialIdentificationSchemeName1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["Id"]},"Acmt023FinancialIdentificationSchemeName1Choice":{"type":"object"},"Acmt023BranchData5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Acmt023PostalAddress27"}}},"Acmt023IdentificationVerification5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"PtyAndAcctId":{"$ref":"#/components/schemas/Acmt023IdentificationInformation5"}},"required":["Id","PtyAndAcctId"]},"Acmt023IdentificationInformation5":{"type":"object","properties":{"Pty":{"$ref":"#/components/schemas/Acmt023PartyIdentification272"},"Acct":{"$ref":"#/components/schemas/Acmt023CashAccount40"},"Agt":{"$ref":"#/components/schemas/Acmt023BranchAndFinancialInstitutionIdentification8"}}},"Acmt023PartyIdentification272":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Acmt023PostalAddress27"},"Id":{"$ref":"#/components/schemas/Acmt023Party52Choice"},"CtryOfRes":{"type":"string","pattern":"[A-Z]{2,2}"},"CtctDtls":{"$ref":"#/components/schemas/Acmt023Contact13"}}},"Acmt023Party52Choice":{"type":"object"},"Acmt023Contact13":{"type":"object","properties":{"NmPrfx":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"Nm":{"type":"string","minLength":1,"maxLength":140},"PhneNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"MobNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"FaxNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"URLAdr":{"type":"string","minLength":1,"maxLength":2048},"EmailAdr":{"type":"string","minLength":1,"maxLength":256},"EmailPurp":{"type":"string","minLength":1,"maxLength":35},"JobTitl":{"type":"string","minLength":1,"maxLength":35},"Rspnsblty":{"type":"string","minLength":1,"maxLength":35},"Dept":{"type":"string","minLength":1,"maxLength":70},"Othr":{"type":"array","items":{"$ref":"#/components/schemas/Acmt023OtherContact1"}},"PrefrdMtd":{"type":"string","enum":["MAIL","FAXX","LETT","CELL","ONLI","PHON"]}}},"Acmt023OtherContact1":{"type":"object","properties":{"ChanlTp":{"type":"string","minLength":1,"maxLength":4},"Id":{"type":"string","minLength":1,"maxLength":128}},"required":["ChanlTp"]},"Acmt023CashAccount40":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Acmt023AccountIdentification4Choice"},"Tp":{"$ref":"#/components/schemas/Acmt023CashAccountType2Choice"},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"},"Nm":{"type":"string","minLength":1,"maxLength":70},"Prxy":{"$ref":"#/components/schemas/Acmt023ProxyAccountIdentification1"}}},"Acmt023AccountIdentification4Choice":{"type":"object"},"Acmt023CashAccountType2Choice":{"type":"object"},"Acmt023ProxyAccountIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Acmt023ProxyAccountType1Choice"},"Id":{"type":"string","minLength":1,"maxLength":2048}},"required":["Id"]},"Acmt023ProxyAccountType1Choice":{"type":"object"},"Acmt023SupplementaryData1":{"type":"object","properties":{"PlcAndNm":{"type":"string","minLength":1,"maxLength":350},"Envlp":{"$ref":"#/components/schemas/Acmt023SupplementaryDataEnvelope1"}},"required":["Envlp"]},"Acmt023SupplementaryDataEnvelope1":{"type":"object"},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/acmt023":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 acmt.023 Identification Verification Request","description":"Submit an ISO 20022 acmt.023 identification verification request. Nexus validates, transforms, and routes the message to the Destination IPS. The asynchronous acmt.024 outcome is delivered to the Source IPS.","operationId":"submitAcmt023","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 acmt.023.001.04 XML payload. Validated against the acmt.023.001.04 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Acmt023Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002, negative acmt.024)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"409":{"description":"Conflict. This request was already accepted and is still being processed. Do not retry - the outcome is delivered separately as an acmt.024."},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```

## Submit an ISO 20022 acmt.024 Identification Verification Report

> Submit an ISO 20022 acmt.024 identification verification report response. Nexus correlates the response to the outstanding acmt.023 from its journal and routes the outcome to the Source IPS. Post-202 failures are communicated asynchronously via admi.002 to the Destination IPS.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["payment.process"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Acmt024Document":{"type":"object","properties":{"IdVrfctnRpt":{"$ref":"#/components/schemas/Acmt024IdentificationVerificationReportV04"}},"required":["IdVrfctnRpt"],"xml":{"name":"Document"}},"Acmt024IdentificationVerificationReportV04":{"type":"object","properties":{"Assgnmt":{"$ref":"#/components/schemas/Acmt024IdentificationAssignment4"},"OrgnlAssgnmt":{"$ref":"#/components/schemas/Acmt024MessageIdentification8"},"Rpt":{"type":"array","items":{"$ref":"#/components/schemas/Acmt024VerificationReport5"}},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Acmt024SupplementaryData1"}}},"required":["Assgnmt","Rpt"]},"Acmt024IdentificationAssignment4":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"},"Cretr":{"$ref":"#/components/schemas/Acmt024Party50Choice"},"FrstAgt":{"$ref":"#/components/schemas/Acmt024BranchAndFinancialInstitutionIdentification8"},"Assgnr":{"$ref":"#/components/schemas/Acmt024Party50Choice"},"Assgne":{"$ref":"#/components/schemas/Acmt024Party50Choice"}},"required":["MsgId","CreDtTm","Assgnr","Assgne"]},"Acmt024Party50Choice":{"type":"object"},"Acmt024BranchAndFinancialInstitutionIdentification8":{"type":"object","properties":{"FinInstnId":{"$ref":"#/components/schemas/Acmt024FinancialInstitutionIdentification23"},"BrnchId":{"$ref":"#/components/schemas/Acmt024BranchData5"}},"required":["FinInstnId"]},"Acmt024FinancialInstitutionIdentification23":{"type":"object","properties":{"BICFI":{"type":"string","pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"},"ClrSysMmbId":{"$ref":"#/components/schemas/Acmt024ClearingSystemMemberIdentification2"},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Acmt024PostalAddress27"},"Othr":{"$ref":"#/components/schemas/Acmt024GenericFinancialIdentification1"}}},"Acmt024ClearingSystemMemberIdentification2":{"type":"object","properties":{"ClrSysId":{"$ref":"#/components/schemas/Acmt024ClearingSystemIdentification2Choice"},"MmbId":{"type":"string","minLength":1,"maxLength":35}},"required":["MmbId"]},"Acmt024ClearingSystemIdentification2Choice":{"type":"object"},"Acmt024PostalAddress27":{"type":"object","properties":{"AdrTp":{"$ref":"#/components/schemas/Acmt024AddressType3Choice"},"CareOf":{"type":"string","minLength":1,"maxLength":140},"Dept":{"type":"string","minLength":1,"maxLength":70},"SubDept":{"type":"string","minLength":1,"maxLength":70},"StrtNm":{"type":"string","minLength":1,"maxLength":140},"BldgNb":{"type":"string","minLength":1,"maxLength":16},"BldgNm":{"type":"string","minLength":1,"maxLength":140},"Flr":{"type":"string","minLength":1,"maxLength":70},"UnitNb":{"type":"string","minLength":1,"maxLength":16},"PstBx":{"type":"string","minLength":1,"maxLength":16},"Room":{"type":"string","minLength":1,"maxLength":70},"PstCd":{"type":"string","minLength":1,"maxLength":16},"TwnNm":{"type":"string","minLength":1,"maxLength":140},"TwnLctnNm":{"type":"string","minLength":1,"maxLength":140},"DstrctNm":{"type":"string","minLength":1,"maxLength":140},"CtrySubDvsn":{"type":"string","minLength":1,"maxLength":35},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"AdrLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":70}}}},"Acmt024AddressType3Choice":{"type":"object"},"Acmt024GenericFinancialIdentification1":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"SchmeNm":{"$ref":"#/components/schemas/Acmt024FinancialIdentificationSchemeName1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["Id"]},"Acmt024FinancialIdentificationSchemeName1Choice":{"type":"object"},"Acmt024BranchData5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Acmt024PostalAddress27"}}},"Acmt024MessageIdentification8":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"},"FrstAgt":{"$ref":"#/components/schemas/Acmt024BranchAndFinancialInstitutionIdentification8"}}},"Acmt024VerificationReport5":{"type":"object","properties":{"OrgnlId":{"type":"string","minLength":1,"maxLength":35},"Vrfctn":{"type":"boolean"},"Rsn":{"$ref":"#/components/schemas/Acmt024VerificationReason1Choice"},"OrgnlPtyAndAcctId":{"$ref":"#/components/schemas/Acmt024IdentificationInformation5"},"UpdtdPtyAndAcctId":{"$ref":"#/components/schemas/Acmt024IdentificationInformation5"}},"required":["OrgnlId","Vrfctn"]},"Acmt024VerificationReason1Choice":{"type":"object"},"Acmt024IdentificationInformation5":{"type":"object","properties":{"Pty":{"$ref":"#/components/schemas/Acmt024PartyIdentification272"},"Acct":{"$ref":"#/components/schemas/Acmt024CashAccount40"},"Agt":{"$ref":"#/components/schemas/Acmt024BranchAndFinancialInstitutionIdentification8"}}},"Acmt024PartyIdentification272":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Acmt024PostalAddress27"},"Id":{"$ref":"#/components/schemas/Acmt024Party52Choice"},"CtryOfRes":{"type":"string","pattern":"[A-Z]{2,2}"},"CtctDtls":{"$ref":"#/components/schemas/Acmt024Contact13"}}},"Acmt024Party52Choice":{"type":"object"},"Acmt024Contact13":{"type":"object","properties":{"NmPrfx":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"Nm":{"type":"string","minLength":1,"maxLength":140},"PhneNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"MobNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"FaxNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"URLAdr":{"type":"string","minLength":1,"maxLength":2048},"EmailAdr":{"type":"string","minLength":1,"maxLength":256},"EmailPurp":{"type":"string","minLength":1,"maxLength":35},"JobTitl":{"type":"string","minLength":1,"maxLength":35},"Rspnsblty":{"type":"string","minLength":1,"maxLength":35},"Dept":{"type":"string","minLength":1,"maxLength":70},"Othr":{"type":"array","items":{"$ref":"#/components/schemas/Acmt024OtherContact1"}},"PrefrdMtd":{"type":"string","enum":["MAIL","FAXX","LETT","CELL","ONLI","PHON"]}}},"Acmt024OtherContact1":{"type":"object","properties":{"ChanlTp":{"type":"string","minLength":1,"maxLength":4},"Id":{"type":"string","minLength":1,"maxLength":128}},"required":["ChanlTp"]},"Acmt024CashAccount40":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Acmt024AccountIdentification4Choice"},"Tp":{"$ref":"#/components/schemas/Acmt024CashAccountType2Choice"},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"},"Nm":{"type":"string","minLength":1,"maxLength":70},"Prxy":{"$ref":"#/components/schemas/Acmt024ProxyAccountIdentification1"}}},"Acmt024AccountIdentification4Choice":{"type":"object"},"Acmt024CashAccountType2Choice":{"type":"object"},"Acmt024ProxyAccountIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Acmt024ProxyAccountType1Choice"},"Id":{"type":"string","minLength":1,"maxLength":2048}},"required":["Id"]},"Acmt024ProxyAccountType1Choice":{"type":"object"},"Acmt024SupplementaryData1":{"type":"object","properties":{"PlcAndNm":{"type":"string","minLength":1,"maxLength":350},"Envlp":{"$ref":"#/components/schemas/Acmt024SupplementaryDataEnvelope1"}},"required":["Envlp"]},"Acmt024SupplementaryDataEnvelope1":{"type":"object"},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/acmt024":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 acmt.024 Identification Verification Report","description":"Submit an ISO 20022 acmt.024 identification verification report response. Nexus correlates the response to the outstanding acmt.023 from its journal and routes the outcome to the Source IPS. Post-202 failures are communicated asynchronously via admi.002 to the Destination IPS.","operationId":"submitAcmt024","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 acmt.024.001.04 XML payload. Validated against the acmt.024.001.04 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Acmt024Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"409":{"description":"Conflict. This request was already accepted and is still being processed. Do not retry - the outcome is delivered separately as an acmt.024."},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```

## Submit an ISO 20022 pacs.028 FI to FI Payment Status Request

> Submit an ISO 20022 pacs.028 FI to FI payment status request. Nexus validates the request and resolves the referenced UETR against its payment journal. The asynchronous outcome is delivered to the Source IPS as a pacs.002 or an admi.002 message reject for technical rejections.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["payment.process"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Pacs028Document":{"type":"object","properties":{"FIToFIPmtStsReq":{"$ref":"#/components/schemas/Pacs028FIToFIPaymentStatusRequestV06"}},"required":["FIToFIPmtStsReq"],"xml":{"name":"Document"}},"Pacs028FIToFIPaymentStatusRequestV06":{"type":"object","properties":{"GrpHdr":{"$ref":"#/components/schemas/Pacs028GroupHeader109"},"OrgnlGrpInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028OriginalGroupInformation27"}},"TxInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028PaymentTransaction158"}},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028SupplementaryData1"}}},"required":["GrpHdr"]},"Pacs028GroupHeader109":{"type":"object","properties":{"MsgId":{"type":"string","minLength":1,"maxLength":35},"CreDtTm":{"type":"string","format":"date-time"},"InstgAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"InstdAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"}},"required":["MsgId","CreDtTm"]},"Pacs028BranchAndFinancialInstitutionIdentification8":{"type":"object","properties":{"FinInstnId":{"$ref":"#/components/schemas/Pacs028FinancialInstitutionIdentification23"},"BrnchId":{"$ref":"#/components/schemas/Pacs028BranchData5"}},"required":["FinInstnId"]},"Pacs028FinancialInstitutionIdentification23":{"type":"object","properties":{"BICFI":{"type":"string","pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"},"ClrSysMmbId":{"$ref":"#/components/schemas/Pacs028ClearingSystemMemberIdentification2"},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs028PostalAddress27"},"Othr":{"$ref":"#/components/schemas/Pacs028GenericFinancialIdentification1"}}},"Pacs028ClearingSystemMemberIdentification2":{"type":"object","properties":{"ClrSysId":{"$ref":"#/components/schemas/Pacs028ClearingSystemIdentification2Choice"},"MmbId":{"type":"string","minLength":1,"maxLength":35}},"required":["MmbId"]},"Pacs028ClearingSystemIdentification2Choice":{"type":"object"},"Pacs028PostalAddress27":{"type":"object","properties":{"AdrTp":{"$ref":"#/components/schemas/Pacs028AddressType3Choice"},"CareOf":{"type":"string","minLength":1,"maxLength":140},"Dept":{"type":"string","minLength":1,"maxLength":70},"SubDept":{"type":"string","minLength":1,"maxLength":70},"StrtNm":{"type":"string","minLength":1,"maxLength":140},"BldgNb":{"type":"string","minLength":1,"maxLength":16},"BldgNm":{"type":"string","minLength":1,"maxLength":140},"Flr":{"type":"string","minLength":1,"maxLength":70},"UnitNb":{"type":"string","minLength":1,"maxLength":16},"PstBx":{"type":"string","minLength":1,"maxLength":16},"Room":{"type":"string","minLength":1,"maxLength":70},"PstCd":{"type":"string","minLength":1,"maxLength":16},"TwnNm":{"type":"string","minLength":1,"maxLength":140},"TwnLctnNm":{"type":"string","minLength":1,"maxLength":140},"DstrctNm":{"type":"string","minLength":1,"maxLength":140},"CtrySubDvsn":{"type":"string","minLength":1,"maxLength":35},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"AdrLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":70}}}},"Pacs028AddressType3Choice":{"type":"object"},"Pacs028GenericFinancialIdentification1":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"SchmeNm":{"$ref":"#/components/schemas/Pacs028FinancialIdentificationSchemeName1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["Id"]},"Pacs028FinancialIdentificationSchemeName1Choice":{"type":"object"},"Pacs028BranchData5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs028PostalAddress27"}}},"Pacs028OriginalGroupInformation27":{"type":"object","properties":{"OrgnlMsgId":{"type":"string","minLength":1,"maxLength":35},"OrgnlMsgNmId":{"type":"string","minLength":1,"maxLength":35},"OrgnlCreDtTm":{"type":"string","format":"date-time"},"OrgnlNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"OrgnlCtrlSum":{"type":"number"}},"required":["OrgnlMsgId","OrgnlMsgNmId"]},"Pacs028PaymentTransaction158":{"type":"object","properties":{"StsReqId":{"type":"string","minLength":1,"maxLength":35},"OrgnlGrpInf":{"$ref":"#/components/schemas/Pacs028OriginalGroupInformation29"},"OrgnlInstrId":{"type":"string","minLength":1,"maxLength":35},"OrgnlEndToEndId":{"type":"string","minLength":1,"maxLength":35},"OrgnlTxId":{"type":"string","minLength":1,"maxLength":35},"OrgnlUETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"AccptncDtTm":{"type":"string","format":"date-time"},"ClrSysRef":{"type":"string","minLength":1,"maxLength":35},"InstgAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"InstdAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"OrgnlTxRef":{"$ref":"#/components/schemas/Pacs028OriginalTransactionReference42"},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028SupplementaryData1"}}}},"Pacs028OriginalGroupInformation29":{"type":"object","properties":{"OrgnlMsgId":{"type":"string","minLength":1,"maxLength":35},"OrgnlMsgNmId":{"type":"string","minLength":1,"maxLength":35},"OrgnlCreDtTm":{"type":"string","format":"date-time"}},"required":["OrgnlMsgId","OrgnlMsgNmId"]},"Pacs028OriginalTransactionReference42":{"type":"object","properties":{"IntrBkSttlmAmt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"Amt":{"$ref":"#/components/schemas/Pacs028AmountType4Choice"},"IntrBkSttlmDt":{"type":"string","format":"date"},"ReqdColltnDt":{"type":"string","format":"date"},"ReqdExctnDt":{"$ref":"#/components/schemas/Pacs028DateAndDateTime2Choice"},"CdtrSchmeId":{"$ref":"#/components/schemas/Pacs028PartyIdentification272"},"SttlmInf":{"$ref":"#/components/schemas/Pacs028SettlementInstruction15"},"PmtTpInf":{"$ref":"#/components/schemas/Pacs028PaymentTypeInformation27"},"PmtMtd":{"type":"string","enum":["CHK","TRF","DD","TRA"]},"MndtRltdInf":{"$ref":"#/components/schemas/Pacs028MandateRelatedData3Choice"},"RmtInf":{"$ref":"#/components/schemas/Pacs028RemittanceInformation22"},"UltmtDbtr":{"$ref":"#/components/schemas/Pacs028Party50Choice"},"Dbtr":{"$ref":"#/components/schemas/Pacs028Party50Choice"},"DbtrAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"DbtrAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"DbtrAgtAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"CdtrAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"CdtrAgtAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"Cdtr":{"$ref":"#/components/schemas/Pacs028Party50Choice"},"CdtrAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"UltmtCdtr":{"$ref":"#/components/schemas/Pacs028Party50Choice"},"Purp":{"$ref":"#/components/schemas/Pacs028Purpose2Choice"}}},"Pacs028ActiveOrHistoricCurrencyAndAmount":{"type":"object","properties":{"value":{"type":"number","minimum":0},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"}},"required":["value","Ccy"]},"Pacs028AmountType4Choice":{"type":"object"},"Pacs028DateAndDateTime2Choice":{"type":"object"},"Pacs028PartyIdentification272":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Pacs028PostalAddress27"},"Id":{"$ref":"#/components/schemas/Pacs028Party52Choice"},"CtryOfRes":{"type":"string","pattern":"[A-Z]{2,2}"},"CtctDtls":{"$ref":"#/components/schemas/Pacs028Contact13"}}},"Pacs028Party52Choice":{"type":"object"},"Pacs028Contact13":{"type":"object","properties":{"NmPrfx":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"Nm":{"type":"string","minLength":1,"maxLength":140},"PhneNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"MobNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"FaxNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"URLAdr":{"type":"string","minLength":1,"maxLength":2048},"EmailAdr":{"type":"string","minLength":1,"maxLength":256},"EmailPurp":{"type":"string","minLength":1,"maxLength":35},"JobTitl":{"type":"string","minLength":1,"maxLength":35},"Rspnsblty":{"type":"string","minLength":1,"maxLength":35},"Dept":{"type":"string","minLength":1,"maxLength":70},"Othr":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028OtherContact1"}},"PrefrdMtd":{"type":"string","enum":["MAIL","FAXX","LETT","CELL","ONLI","PHON"]}}},"Pacs028OtherContact1":{"type":"object","properties":{"ChanlTp":{"type":"string","minLength":1,"maxLength":4},"Id":{"type":"string","minLength":1,"maxLength":128}},"required":["ChanlTp"]},"Pacs028SettlementInstruction15":{"type":"object","properties":{"SttlmMtd":{"type":"string","enum":["INDA","INGA","COVE","CLRG"]},"SttlmAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"ClrSys":{"$ref":"#/components/schemas/Pacs028ClearingSystemIdentification3Choice"},"InstgRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"InstgRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"InstdRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"InstdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"},"ThrdRmbrsmntAgt":{"$ref":"#/components/schemas/Pacs028BranchAndFinancialInstitutionIdentification8"},"ThrdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Pacs028CashAccount40"}},"required":["SttlmMtd"]},"Pacs028CashAccount40":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Pacs028AccountIdentification4Choice"},"Tp":{"$ref":"#/components/schemas/Pacs028CashAccountType2Choice"},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"},"Nm":{"type":"string","minLength":1,"maxLength":70},"Prxy":{"$ref":"#/components/schemas/Pacs028ProxyAccountIdentification1"}}},"Pacs028AccountIdentification4Choice":{"type":"object"},"Pacs028CashAccountType2Choice":{"type":"object"},"Pacs028ProxyAccountIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028ProxyAccountType1Choice"},"Id":{"type":"string","minLength":1,"maxLength":2048}},"required":["Id"]},"Pacs028ProxyAccountType1Choice":{"type":"object"},"Pacs028ClearingSystemIdentification3Choice":{"type":"object"},"Pacs028PaymentTypeInformation27":{"type":"object","properties":{"InstrPrty":{"type":"string","enum":["HIGH","NORM"]},"ClrChanl":{"type":"string","enum":["RTGS","RTNS","MPNS","BOOK"]},"SvcLvl":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028ServiceLevel8Choice"}},"LclInstrm":{"$ref":"#/components/schemas/Pacs028LocalInstrument2Choice"},"SeqTp":{"type":"string","enum":["FRST","RCUR","FNAL","OOFF","RPRE"]},"CtgyPurp":{"$ref":"#/components/schemas/Pacs028CategoryPurpose1Choice"}}},"Pacs028ServiceLevel8Choice":{"type":"object"},"Pacs028LocalInstrument2Choice":{"type":"object"},"Pacs028CategoryPurpose1Choice":{"type":"object"},"Pacs028MandateRelatedData3Choice":{"type":"object"},"Pacs028RemittanceInformation22":{"type":"object","properties":{"Ustrd":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"Strd":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028StructuredRemittanceInformation18"}}}},"Pacs028StructuredRemittanceInformation18":{"type":"object","properties":{"RfrdDocInf":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028ReferredDocumentInformation8"}},"RfrdDocAmt":{"$ref":"#/components/schemas/Pacs028RemittanceAmount4"},"CdtrRefInf":{"$ref":"#/components/schemas/Pacs028CreditorReferenceInformation3"},"Invcr":{"$ref":"#/components/schemas/Pacs028PartyIdentification272"},"Invcee":{"$ref":"#/components/schemas/Pacs028PartyIdentification272"},"TaxRmt":{"$ref":"#/components/schemas/Pacs028TaxData1"},"GrnshmtRmt":{"$ref":"#/components/schemas/Pacs028Garnishment4"},"AddtlRmtInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}}}},"Pacs028ReferredDocumentInformation8":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028DocumentType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"$ref":"#/components/schemas/Pacs028DateAndType1"},"LineDtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028DocumentLineInformation2"}}}},"Pacs028DocumentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs028DocumentType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs028DocumentType2Choice":{"type":"object"},"Pacs028DateAndType1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028DateType2Choice"},"Dt":{"type":"string","format":"date"}},"required":["Tp","Dt"]},"Pacs028DateType2Choice":{"type":"object"},"Pacs028DocumentLineInformation2":{"type":"object","properties":{"Id":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028DocumentLineIdentification1"}},"Desc":{"type":"string","minLength":1,"maxLength":2048},"Amt":{"$ref":"#/components/schemas/Pacs028RemittanceAmount4"}},"required":["Id"]},"Pacs028DocumentLineIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028DocumentLineType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"type":"string","format":"date"}}},"Pacs028DocumentLineType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs028DocumentLineType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs028DocumentLineType1Choice":{"type":"object"},"Pacs028RemittanceAmount4":{"type":"object","properties":{"RmtAmtAndTp":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028DocumentAmount1"}},"AdjstmntAmtAndRsn":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028DocumentAdjustment1"}}}},"Pacs028DocumentAmount1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028DocumentAmountType1Choice"},"Amt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"}},"required":["Tp","Amt"]},"Pacs028DocumentAmountType1Choice":{"type":"object"},"Pacs028DocumentAdjustment1":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"CdtDbtInd":{"type":"string","enum":["CRDT","DBIT"]},"Rsn":{"type":"string","minLength":1,"maxLength":4},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}},"required":["Amt"]},"Pacs028CreditorReferenceInformation3":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028CreditorReferenceType3"},"Ref":{"type":"string","minLength":1,"maxLength":35}}},"Pacs028CreditorReferenceType3":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs028CreditorReferenceType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs028CreditorReferenceType2Choice":{"type":"object"},"Pacs028TaxData1":{"type":"object","properties":{"Cdtr":{"$ref":"#/components/schemas/Pacs028TaxParty1"},"Dbtr":{"$ref":"#/components/schemas/Pacs028TaxParty2"},"UltmtDbtr":{"$ref":"#/components/schemas/Pacs028TaxParty2"},"AdmstnZone":{"type":"string","minLength":1,"maxLength":35},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Mtd":{"type":"string","minLength":1,"maxLength":35},"TtlTaxblBaseAmt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"TtlTaxAmt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"Dt":{"type":"string","format":"date"},"SeqNb":{"type":"number"},"Rcrd":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028TaxRecord3"}}}},"Pacs028TaxParty1":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35}}},"Pacs028TaxParty2":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35},"Authstn":{"$ref":"#/components/schemas/Pacs028TaxAuthorisation1"}}},"Pacs028TaxAuthorisation1":{"type":"object","properties":{"Titl":{"type":"string","minLength":1,"maxLength":35},"Nm":{"type":"string","minLength":1,"maxLength":140}}},"Pacs028TaxRecord3":{"type":"object","properties":{"Tp":{"type":"string","minLength":1,"maxLength":35},"Ctgy":{"type":"string","minLength":1,"maxLength":35},"CtgyDtls":{"type":"string","minLength":1,"maxLength":35},"DbtrSts":{"type":"string","minLength":1,"maxLength":35},"CertId":{"type":"string","minLength":1,"maxLength":35},"FrmsCd":{"type":"string","minLength":1,"maxLength":35},"Prd":{"$ref":"#/components/schemas/Pacs028TaxPeriod3"},"TaxAmt":{"$ref":"#/components/schemas/Pacs028TaxAmount3"},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}}},"Pacs028TaxPeriod3":{"type":"object","properties":{"Yr":{"type":"string"},"Tp":{"type":"string","enum":["MM01","MM02","MM03","MM04","MM05","MM06","MM07","MM08","MM09","MM10","MM11","MM12","QTR1","QTR2","QTR3","QTR4","HLF1","HLF2"]},"FrToDt":{"$ref":"#/components/schemas/Pacs028DatePeriod2"}}},"Pacs028DatePeriod2":{"type":"object","properties":{"FrDt":{"type":"string","format":"date"},"ToDt":{"type":"string","format":"date"}},"required":["FrDt","ToDt"]},"Pacs028TaxAmount3":{"type":"object","properties":{"Rate":{"type":"number"},"TaxblBaseAmt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"TtlAmt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"Dtls":{"type":"array","items":{"$ref":"#/components/schemas/Pacs028TaxRecordDetails3"}}}},"Pacs028TaxRecordDetails3":{"type":"object","properties":{"Prd":{"$ref":"#/components/schemas/Pacs028TaxPeriod3"},"Amt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"}},"required":["Amt"]},"Pacs028Garnishment4":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Pacs028GarnishmentType1"},"Grnshee":{"$ref":"#/components/schemas/Pacs028PartyIdentification272"},"GrnshmtAdmstr":{"$ref":"#/components/schemas/Pacs028PartyIdentification272"},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Dt":{"type":"string","format":"date"},"RmtdAmt":{"$ref":"#/components/schemas/Pacs028ActiveOrHistoricCurrencyAndAmount"},"FmlyMdclInsrncInd":{"type":"boolean"},"MplyeeTermntnInd":{"type":"boolean"}},"required":["Tp"]},"Pacs028GarnishmentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Pacs028GarnishmentType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Pacs028GarnishmentType1Choice":{"type":"object"},"Pacs028Party50Choice":{"type":"object"},"Pacs028Purpose2Choice":{"type":"object"},"Pacs028SupplementaryData1":{"type":"object","properties":{"PlcAndNm":{"type":"string","minLength":1,"maxLength":350},"Envlp":{"$ref":"#/components/schemas/Pacs028SupplementaryDataEnvelope1"}},"required":["Envlp"]},"Pacs028SupplementaryDataEnvelope1":{"type":"object"},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/pacs028":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 pacs.028 FI to FI Payment Status Request","description":"Submit an ISO 20022 pacs.028 FI to FI payment status request. Nexus validates the request and resolves the referenced UETR against its payment journal. The asynchronous outcome is delivered to the Source IPS as a pacs.002 or an admi.002 message reject for technical rejections.","operationId":"submitPacs028","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 pacs.028.001.06 XML payload. Validated against the pacs.028.001.06 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Pacs028Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002, negative pacs.002)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"409":{"description":"Conflict. This request was already accepted and is still being processed. Do not retry - use a pacs.028 status request to check the outcome."},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```

## Submit an ISO 20022 camt.029 Resolution of Investigation

> Submit an ISO 20022 camt.029 resolution of investigation response. Nexus validates and correlates the resolution against the outstanding camt.056 cancellation in its journal by OrgnlUETR. Validation or correlation failures are surfaced via the Nexus Operations Service Desk.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["payment.process"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Camt029Document":{"type":"object","properties":{"RsltnOfInvstgtn":{"$ref":"#/components/schemas/Camt029ResolutionOfInvestigationV13"}},"required":["RsltnOfInvstgtn"],"xml":{"name":"Document"}},"Camt029ResolutionOfInvestigationV13":{"type":"object","properties":{"Assgnmt":{"$ref":"#/components/schemas/Camt029CaseAssignment6"},"RslvdCase":{"$ref":"#/components/schemas/Camt029Case6"},"Sts":{"$ref":"#/components/schemas/Camt029InvestigationStatus6Choice"},"CxlDtls":{"type":"array","items":{"$ref":"#/components/schemas/Camt029UnderlyingTransaction32"}},"ModDtls":{"$ref":"#/components/schemas/Camt029PaymentTransaction157"},"ClmNonRctDtls":{"$ref":"#/components/schemas/Camt029ClaimNonReceipt3Choice"},"StmtDtls":{"$ref":"#/components/schemas/Camt029StatementResolutionEntry5"},"CrrctnTx":{"$ref":"#/components/schemas/Camt029CorrectiveTransaction5Choice"},"RsltnRltdInf":{"$ref":"#/components/schemas/Camt029ResolutionData5"},"SplmtryData":{"type":"array","items":{"$ref":"#/components/schemas/Camt029SupplementaryData1"}}},"required":["Assgnmt","Sts"]},"Camt029CaseAssignment6":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"Assgnr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"Assgne":{"$ref":"#/components/schemas/Camt029Party50Choice"},"CreDtTm":{"type":"string","format":"date-time"}},"required":["Id","Assgnr","Assgne","CreDtTm"]},"Camt029Party50Choice":{"type":"object"},"Camt029Case6":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"Cretr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"ReopCaseIndctn":{"type":"boolean"}},"required":["Id","Cretr"]},"Camt029InvestigationStatus6Choice":{"type":"object"},"Camt029UnderlyingTransaction32":{"type":"object","properties":{"OrgnlGrpInfAndSts":{"$ref":"#/components/schemas/Camt029OriginalGroupHeader23"},"OrgnlPmtInfAndSts":{"type":"array","items":{"$ref":"#/components/schemas/Camt029OriginalPaymentInstruction48"}},"TxInfAndSts":{"type":"array","items":{"$ref":"#/components/schemas/Camt029PaymentTransaction152"}}}},"Camt029OriginalGroupHeader23":{"type":"object","properties":{"OrgnlGrpCxlId":{"type":"string","minLength":1,"maxLength":35},"RslvdCase":{"$ref":"#/components/schemas/Camt029Case6"},"OrgnlMsgId":{"type":"string","minLength":1,"maxLength":35},"OrgnlMsgNmId":{"type":"string","minLength":1,"maxLength":35},"OrgnlCreDtTm":{"type":"string","format":"date-time"},"OrgnlNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"OrgnlCtrlSum":{"type":"number"},"GrpCxlSts":{"type":"string","enum":["PACR","RJCR","ACCR","PDCR"]},"CxlStsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029CancellationStatusReason5"}},"NbOfTxsPerCxlSts":{"type":"array","items":{"$ref":"#/components/schemas/Camt029NumberOfTransactionsPerStatus1"}}},"required":["OrgnlMsgId","OrgnlMsgNmId"]},"Camt029CancellationStatusReason5":{"type":"object","properties":{"Orgtr":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"Rsn":{"$ref":"#/components/schemas/Camt029CancellationStatusReason3Choice"},"AddtlInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":105}}}},"Camt029PartyIdentification272":{"type":"object","properties":{"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Camt029PostalAddress27"},"Id":{"$ref":"#/components/schemas/Camt029Party52Choice"},"CtryOfRes":{"type":"string","pattern":"[A-Z]{2,2}"},"CtctDtls":{"$ref":"#/components/schemas/Camt029Contact13"}}},"Camt029PostalAddress27":{"type":"object","properties":{"AdrTp":{"$ref":"#/components/schemas/Camt029AddressType3Choice"},"CareOf":{"type":"string","minLength":1,"maxLength":140},"Dept":{"type":"string","minLength":1,"maxLength":70},"SubDept":{"type":"string","minLength":1,"maxLength":70},"StrtNm":{"type":"string","minLength":1,"maxLength":140},"BldgNb":{"type":"string","minLength":1,"maxLength":16},"BldgNm":{"type":"string","minLength":1,"maxLength":140},"Flr":{"type":"string","minLength":1,"maxLength":70},"UnitNb":{"type":"string","minLength":1,"maxLength":16},"PstBx":{"type":"string","minLength":1,"maxLength":16},"Room":{"type":"string","minLength":1,"maxLength":70},"PstCd":{"type":"string","minLength":1,"maxLength":16},"TwnNm":{"type":"string","minLength":1,"maxLength":140},"TwnLctnNm":{"type":"string","minLength":1,"maxLength":140},"DstrctNm":{"type":"string","minLength":1,"maxLength":140},"CtrySubDvsn":{"type":"string","minLength":1,"maxLength":35},"Ctry":{"type":"string","pattern":"[A-Z]{2,2}"},"AdrLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":70}}}},"Camt029AddressType3Choice":{"type":"object"},"Camt029Party52Choice":{"type":"object"},"Camt029Contact13":{"type":"object","properties":{"NmPrfx":{"type":"string","enum":["DOCT","MADM","MISS","MIST","MIKS"]},"Nm":{"type":"string","minLength":1,"maxLength":140},"PhneNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"MobNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"FaxNb":{"type":"string","pattern":"\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"},"URLAdr":{"type":"string","minLength":1,"maxLength":2048},"EmailAdr":{"type":"string","minLength":1,"maxLength":256},"EmailPurp":{"type":"string","minLength":1,"maxLength":35},"JobTitl":{"type":"string","minLength":1,"maxLength":35},"Rspnsblty":{"type":"string","minLength":1,"maxLength":35},"Dept":{"type":"string","minLength":1,"maxLength":70},"Othr":{"type":"array","items":{"$ref":"#/components/schemas/Camt029OtherContact1"}},"PrefrdMtd":{"type":"string","enum":["MAIL","FAXX","LETT","CELL","ONLI","PHON"]}}},"Camt029OtherContact1":{"type":"object","properties":{"ChanlTp":{"type":"string","minLength":1,"maxLength":4},"Id":{"type":"string","minLength":1,"maxLength":128}},"required":["ChanlTp"]},"Camt029CancellationStatusReason3Choice":{"type":"object"},"Camt029NumberOfTransactionsPerStatus1":{"type":"object","properties":{"DtldNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"DtldSts":{"type":"string","enum":["ACTC","RJCT","PDNG","ACCP","ACSP","ACSC","ACCR","ACWC"]},"DtldCtrlSum":{"type":"number"}},"required":["DtldNbOfTxs","DtldSts"]},"Camt029OriginalPaymentInstruction48":{"type":"object","properties":{"OrgnlPmtInfCxlId":{"type":"string","minLength":1,"maxLength":35},"RslvdCase":{"$ref":"#/components/schemas/Camt029Case6"},"OrgnlPmtInfId":{"type":"string","minLength":1,"maxLength":35},"OrgnlGrpInf":{"$ref":"#/components/schemas/Camt029OriginalGroupInformation29"},"OrgnlNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"OrgnlCtrlSum":{"type":"number"},"PmtInfCxlSts":{"type":"string","enum":["PACR","RJCR","ACCR","PDCR"]},"CxlStsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029CancellationStatusReason5"}},"NbOfTxsPerCxlSts":{"type":"array","items":{"$ref":"#/components/schemas/Camt029NumberOfCancellationsPerStatus1"}},"TxInfAndSts":{"type":"array","items":{"$ref":"#/components/schemas/Camt029PaymentTransaction153"}}},"required":["OrgnlPmtInfId"]},"Camt029OriginalGroupInformation29":{"type":"object","properties":{"OrgnlMsgId":{"type":"string","minLength":1,"maxLength":35},"OrgnlMsgNmId":{"type":"string","minLength":1,"maxLength":35},"OrgnlCreDtTm":{"type":"string","format":"date-time"}},"required":["OrgnlMsgId","OrgnlMsgNmId"]},"Camt029NumberOfCancellationsPerStatus1":{"type":"object","properties":{"DtldNbOfTxs":{"type":"string","pattern":"[0-9]{1,15}"},"DtldSts":{"type":"string","enum":["RJCR","ACCR","PDCR"]},"DtldCtrlSum":{"type":"number"}},"required":["DtldNbOfTxs","DtldSts"]},"Camt029PaymentTransaction153":{"type":"object","properties":{"CxlStsId":{"type":"string","minLength":1,"maxLength":35},"RslvdCase":{"$ref":"#/components/schemas/Camt029Case6"},"OrgnlInstrId":{"type":"string","minLength":1,"maxLength":35},"OrgnlEndToEndId":{"type":"string","minLength":1,"maxLength":35},"UETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"TxCxlSts":{"type":"string","enum":["RJCR","ACCR","PDCR"]},"CxlStsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029CancellationStatusReason5"}},"OrgnlInstdAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"OrgnlReqdExctnDt":{"$ref":"#/components/schemas/Camt029DateAndDateTime2Choice"},"OrgnlReqdColltnDt":{"type":"string","format":"date"},"OrgnlTxRef":{"$ref":"#/components/schemas/Camt029OriginalTransactionReference42"}}},"Camt029ActiveOrHistoricCurrencyAndAmount":{"type":"object","properties":{"value":{"type":"number","minimum":0},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"}},"required":["value","Ccy"]},"Camt029DateAndDateTime2Choice":{"type":"object"},"Camt029OriginalTransactionReference42":{"type":"object","properties":{"IntrBkSttlmAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"Amt":{"$ref":"#/components/schemas/Camt029AmountType4Choice"},"IntrBkSttlmDt":{"type":"string","format":"date"},"ReqdColltnDt":{"type":"string","format":"date"},"ReqdExctnDt":{"$ref":"#/components/schemas/Camt029DateAndDateTime2Choice"},"CdtrSchmeId":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"SttlmInf":{"$ref":"#/components/schemas/Camt029SettlementInstruction15"},"PmtTpInf":{"$ref":"#/components/schemas/Camt029PaymentTypeInformation27"},"PmtMtd":{"type":"string","enum":["CHK","TRF","DD","TRA"]},"MndtRltdInf":{"$ref":"#/components/schemas/Camt029MandateRelatedData3Choice"},"RmtInf":{"$ref":"#/components/schemas/Camt029RemittanceInformation22"},"UltmtDbtr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"Dbtr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"DbtrAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"DbtrAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"DbtrAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"CdtrAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"CdtrAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"Cdtr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"CdtrAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"UltmtCdtr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"Purp":{"$ref":"#/components/schemas/Camt029Purpose2Choice"}}},"Camt029AmountType4Choice":{"type":"object"},"Camt029SettlementInstruction15":{"type":"object","properties":{"SttlmMtd":{"type":"string","enum":["INDA","INGA","COVE","CLRG"]},"SttlmAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"ClrSys":{"$ref":"#/components/schemas/Camt029ClearingSystemIdentification3Choice"},"InstgRmbrsmntAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"InstgRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"InstdRmbrsmntAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"InstdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"ThrdRmbrsmntAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"ThrdRmbrsmntAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"}},"required":["SttlmMtd"]},"Camt029CashAccount40":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Camt029AccountIdentification4Choice"},"Tp":{"$ref":"#/components/schemas/Camt029CashAccountType2Choice"},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"},"Nm":{"type":"string","minLength":1,"maxLength":70},"Prxy":{"$ref":"#/components/schemas/Camt029ProxyAccountIdentification1"}}},"Camt029AccountIdentification4Choice":{"type":"object"},"Camt029CashAccountType2Choice":{"type":"object"},"Camt029ProxyAccountIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029ProxyAccountType1Choice"},"Id":{"type":"string","minLength":1,"maxLength":2048}},"required":["Id"]},"Camt029ProxyAccountType1Choice":{"type":"object"},"Camt029ClearingSystemIdentification3Choice":{"type":"object"},"Camt029BranchAndFinancialInstitutionIdentification8":{"type":"object","properties":{"FinInstnId":{"$ref":"#/components/schemas/Camt029FinancialInstitutionIdentification23"},"BrnchId":{"$ref":"#/components/schemas/Camt029BranchData5"}},"required":["FinInstnId"]},"Camt029FinancialInstitutionIdentification23":{"type":"object","properties":{"BICFI":{"type":"string","pattern":"[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"},"ClrSysMmbId":{"$ref":"#/components/schemas/Camt029ClearingSystemMemberIdentification2"},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Camt029PostalAddress27"},"Othr":{"$ref":"#/components/schemas/Camt029GenericFinancialIdentification1"}}},"Camt029ClearingSystemMemberIdentification2":{"type":"object","properties":{"ClrSysId":{"$ref":"#/components/schemas/Camt029ClearingSystemIdentification2Choice"},"MmbId":{"type":"string","minLength":1,"maxLength":35}},"required":["MmbId"]},"Camt029ClearingSystemIdentification2Choice":{"type":"object"},"Camt029GenericFinancialIdentification1":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"SchmeNm":{"$ref":"#/components/schemas/Camt029FinancialIdentificationSchemeName1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["Id"]},"Camt029FinancialIdentificationSchemeName1Choice":{"type":"object"},"Camt029BranchData5":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"LEI":{"type":"string","pattern":"[A-Z0-9]{18,18}[0-9]{2,2}"},"Nm":{"type":"string","minLength":1,"maxLength":140},"PstlAdr":{"$ref":"#/components/schemas/Camt029PostalAddress27"}}},"Camt029PaymentTypeInformation27":{"type":"object","properties":{"InstrPrty":{"type":"string","enum":["HIGH","NORM"]},"ClrChanl":{"type":"string","enum":["RTGS","RTNS","MPNS","BOOK"]},"SvcLvl":{"type":"array","items":{"$ref":"#/components/schemas/Camt029ServiceLevel8Choice"}},"LclInstrm":{"$ref":"#/components/schemas/Camt029LocalInstrument2Choice"},"SeqTp":{"type":"string","enum":["FRST","RCUR","FNAL","OOFF","RPRE"]},"CtgyPurp":{"$ref":"#/components/schemas/Camt029CategoryPurpose1Choice"}}},"Camt029ServiceLevel8Choice":{"type":"object"},"Camt029LocalInstrument2Choice":{"type":"object"},"Camt029CategoryPurpose1Choice":{"type":"object"},"Camt029MandateRelatedData3Choice":{"type":"object"},"Camt029RemittanceInformation22":{"type":"object","properties":{"Ustrd":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"Strd":{"type":"array","items":{"$ref":"#/components/schemas/Camt029StructuredRemittanceInformation18"}}}},"Camt029StructuredRemittanceInformation18":{"type":"object","properties":{"RfrdDocInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029ReferredDocumentInformation8"}},"RfrdDocAmt":{"$ref":"#/components/schemas/Camt029RemittanceAmount4"},"CdtrRefInf":{"$ref":"#/components/schemas/Camt029CreditorReferenceInformation3"},"Invcr":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"Invcee":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"TaxRmt":{"$ref":"#/components/schemas/Camt029TaxData1"},"GrnshmtRmt":{"$ref":"#/components/schemas/Camt029Garnishment4"},"AddtlRmtInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":140}}}},"Camt029ReferredDocumentInformation8":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029DocumentType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"$ref":"#/components/schemas/Camt029DateAndType1"},"LineDtls":{"type":"array","items":{"$ref":"#/components/schemas/Camt029DocumentLineInformation2"}}}},"Camt029DocumentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Camt029DocumentType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Camt029DocumentType2Choice":{"type":"object"},"Camt029DateAndType1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029DateType2Choice"},"Dt":{"type":"string","format":"date"}},"required":["Tp","Dt"]},"Camt029DateType2Choice":{"type":"object"},"Camt029DocumentLineInformation2":{"type":"object","properties":{"Id":{"type":"array","items":{"$ref":"#/components/schemas/Camt029DocumentLineIdentification1"}},"Desc":{"type":"string","minLength":1,"maxLength":2048},"Amt":{"$ref":"#/components/schemas/Camt029RemittanceAmount4"}},"required":["Id"]},"Camt029DocumentLineIdentification1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029DocumentLineType1"},"Nb":{"type":"string","minLength":1,"maxLength":35},"RltdDt":{"type":"string","format":"date"}}},"Camt029DocumentLineType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Camt029DocumentLineType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Camt029DocumentLineType1Choice":{"type":"object"},"Camt029RemittanceAmount4":{"type":"object","properties":{"RmtAmtAndTp":{"type":"array","items":{"$ref":"#/components/schemas/Camt029DocumentAmount1"}},"AdjstmntAmtAndRsn":{"type":"array","items":{"$ref":"#/components/schemas/Camt029DocumentAdjustment1"}}}},"Camt029DocumentAmount1":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029DocumentAmountType1Choice"},"Amt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"}},"required":["Tp","Amt"]},"Camt029DocumentAmountType1Choice":{"type":"object"},"Camt029DocumentAdjustment1":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"CdtDbtInd":{"type":"string","enum":["CRDT","DBIT"]},"Rsn":{"type":"string","minLength":1,"maxLength":4},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}},"required":["Amt"]},"Camt029CreditorReferenceInformation3":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029CreditorReferenceType3"},"Ref":{"type":"string","minLength":1,"maxLength":35}}},"Camt029CreditorReferenceType3":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Camt029CreditorReferenceType2Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Camt029CreditorReferenceType2Choice":{"type":"object"},"Camt029TaxData1":{"type":"object","properties":{"Cdtr":{"$ref":"#/components/schemas/Camt029TaxParty1"},"Dbtr":{"$ref":"#/components/schemas/Camt029TaxParty2"},"UltmtDbtr":{"$ref":"#/components/schemas/Camt029TaxParty2"},"AdmstnZone":{"type":"string","minLength":1,"maxLength":35},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Mtd":{"type":"string","minLength":1,"maxLength":35},"TtlTaxblBaseAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"TtlTaxAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"Dt":{"type":"string","format":"date"},"SeqNb":{"type":"number"},"Rcrd":{"type":"array","items":{"$ref":"#/components/schemas/Camt029TaxRecord3"}}}},"Camt029TaxParty1":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35}}},"Camt029TaxParty2":{"type":"object","properties":{"TaxId":{"type":"string","minLength":1,"maxLength":35},"RegnId":{"type":"string","minLength":1,"maxLength":35},"TaxTp":{"type":"string","minLength":1,"maxLength":35},"Authstn":{"$ref":"#/components/schemas/Camt029TaxAuthorisation1"}}},"Camt029TaxAuthorisation1":{"type":"object","properties":{"Titl":{"type":"string","minLength":1,"maxLength":35},"Nm":{"type":"string","minLength":1,"maxLength":140}}},"Camt029TaxRecord3":{"type":"object","properties":{"Tp":{"type":"string","minLength":1,"maxLength":35},"Ctgy":{"type":"string","minLength":1,"maxLength":35},"CtgyDtls":{"type":"string","minLength":1,"maxLength":35},"DbtrSts":{"type":"string","minLength":1,"maxLength":35},"CertId":{"type":"string","minLength":1,"maxLength":35},"FrmsCd":{"type":"string","minLength":1,"maxLength":35},"Prd":{"$ref":"#/components/schemas/Camt029TaxPeriod3"},"TaxAmt":{"$ref":"#/components/schemas/Camt029TaxAmount3"},"AddtlInf":{"type":"string","minLength":1,"maxLength":140}}},"Camt029TaxPeriod3":{"type":"object","properties":{"Yr":{"type":"string"},"Tp":{"type":"string","enum":["MM01","MM02","MM03","MM04","MM05","MM06","MM07","MM08","MM09","MM10","MM11","MM12","QTR1","QTR2","QTR3","QTR4","HLF1","HLF2"]},"FrToDt":{"$ref":"#/components/schemas/Camt029DatePeriod2"}}},"Camt029DatePeriod2":{"type":"object","properties":{"FrDt":{"type":"string","format":"date"},"ToDt":{"type":"string","format":"date"}},"required":["FrDt","ToDt"]},"Camt029TaxAmount3":{"type":"object","properties":{"Rate":{"type":"number"},"TaxblBaseAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"TtlAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"Dtls":{"type":"array","items":{"$ref":"#/components/schemas/Camt029TaxRecordDetails3"}}}},"Camt029TaxRecordDetails3":{"type":"object","properties":{"Prd":{"$ref":"#/components/schemas/Camt029TaxPeriod3"},"Amt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"}},"required":["Amt"]},"Camt029Garnishment4":{"type":"object","properties":{"Tp":{"$ref":"#/components/schemas/Camt029GarnishmentType1"},"Grnshee":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"GrnshmtAdmstr":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"RefNb":{"type":"string","minLength":1,"maxLength":140},"Dt":{"type":"string","format":"date"},"RmtdAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"FmlyMdclInsrncInd":{"type":"boolean"},"MplyeeTermntnInd":{"type":"boolean"}},"required":["Tp"]},"Camt029GarnishmentType1":{"type":"object","properties":{"CdOrPrtry":{"$ref":"#/components/schemas/Camt029GarnishmentType1Choice"},"Issr":{"type":"string","minLength":1,"maxLength":35}},"required":["CdOrPrtry"]},"Camt029GarnishmentType1Choice":{"type":"object"},"Camt029Purpose2Choice":{"type":"object"},"Camt029PaymentTransaction152":{"type":"object","properties":{"CxlStsId":{"type":"string","minLength":1,"maxLength":35},"RslvdCase":{"$ref":"#/components/schemas/Camt029Case6"},"OrgnlGrpInf":{"$ref":"#/components/schemas/Camt029OriginalGroupInformation29"},"OrgnlInstrId":{"type":"string","minLength":1,"maxLength":35},"OrgnlEndToEndId":{"type":"string","minLength":1,"maxLength":35},"OrgnlTxId":{"type":"string","minLength":1,"maxLength":35},"OrgnlClrSysRef":{"type":"string","minLength":1,"maxLength":35},"OrgnlUETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"TxCxlSts":{"type":"string","enum":["RJCR","ACCR","PDCR"]},"CxlStsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029CancellationStatusReason5"}},"RsltnRltdInf":{"$ref":"#/components/schemas/Camt029ResolutionData5"},"OrgnlIntrBkSttlmAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"OrgnlIntrBkSttlmDt":{"type":"string","format":"date"},"Assgnr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"Assgne":{"$ref":"#/components/schemas/Camt029Party50Choice"},"OrgnlTxRef":{"$ref":"#/components/schemas/Camt029OriginalTransactionReference42"}}},"Camt029ResolutionData5":{"type":"object","properties":{"EndToEndId":{"type":"string","minLength":1,"maxLength":35},"TxId":{"type":"string","minLength":1,"maxLength":35},"UETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"IntrBkSttlmAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"IntrBkSttlmDt":{"type":"string","format":"date"},"ClrChanl":{"type":"string","enum":["RTGS","RTNS","MPNS","BOOK"]},"Compstn":{"$ref":"#/components/schemas/Camt029Compensation5"},"ChrgsInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029Charges14"}}}},"Camt029Compensation5":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Camt029ActiveCurrencyAndAmount"},"DbtrAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"DbtrAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"CdtrAgt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"CdtrAgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"Rsn":{"$ref":"#/components/schemas/Camt029CompensationReason1Choice"}},"required":["Amt","DbtrAgt","CdtrAgt","Rsn"]},"Camt029ActiveCurrencyAndAmount":{"type":"object","properties":{"value":{"type":"number","minimum":0},"Ccy":{"type":"string","pattern":"[A-Z]{3,3}"}},"required":["value","Ccy"]},"Camt029CompensationReason1Choice":{"type":"object"},"Camt029Charges14":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"Agt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"AgtAcct":{"$ref":"#/components/schemas/Camt029CashAccount40"},"Tp":{"$ref":"#/components/schemas/Camt029ChargeType3Choice"}},"required":["Amt","Agt"]},"Camt029ChargeType3Choice":{"type":"object"},"Camt029PaymentTransaction157":{"type":"object","properties":{"ModStsId":{"type":"string","minLength":1,"maxLength":35},"RslvdCase":{"$ref":"#/components/schemas/Camt029Case6"},"OrgnlGrpInf":{"$ref":"#/components/schemas/Camt029OriginalGroupInformation29"},"OrgnlPmtInfId":{"type":"string","minLength":1,"maxLength":35},"OrgnlInstrId":{"type":"string","minLength":1,"maxLength":35},"OrgnlEndToEndId":{"type":"string","minLength":1,"maxLength":35},"OrgnlTxId":{"type":"string","minLength":1,"maxLength":35},"OrgnlClrSysRef":{"type":"string","minLength":1,"maxLength":35},"OrgnlUETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"ModStsRsnInf":{"type":"array","items":{"$ref":"#/components/schemas/Camt029ModificationStatusReason3"}},"RsltnRltdInf":{"$ref":"#/components/schemas/Camt029ResolutionData5"},"OrgnlIntrBkSttlmAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"OrgnlIntrBkSttlmDt":{"type":"string","format":"date"},"Assgnr":{"$ref":"#/components/schemas/Camt029Party50Choice"},"Assgne":{"$ref":"#/components/schemas/Camt029Party50Choice"},"OrgnlTxRef":{"$ref":"#/components/schemas/Camt029OriginalTransactionReference42"}},"required":["OrgnlGrpInf"]},"Camt029ModificationStatusReason3":{"type":"object","properties":{"Orgtr":{"$ref":"#/components/schemas/Camt029PartyIdentification272"},"Rsn":{"$ref":"#/components/schemas/Camt029ModificationStatusReason1Choice"},"AddtlInf":{"type":"array","items":{"type":"string","minLength":1,"maxLength":105}}}},"Camt029ModificationStatusReason1Choice":{"type":"object"},"Camt029ClaimNonReceipt3Choice":{"type":"object"},"Camt029StatementResolutionEntry5":{"type":"object","properties":{"OrgnlGrpInf":{"$ref":"#/components/schemas/Camt029OriginalGroupInformation29"},"OrgnlStmtId":{"type":"string","minLength":1,"maxLength":35},"UETR":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}"},"AcctSvcrRef":{"type":"string","minLength":1,"maxLength":35},"CrrctdAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"Chrgs":{"type":"array","items":{"$ref":"#/components/schemas/Camt029Charges15"}},"Purp":{"$ref":"#/components/schemas/Camt029Purpose2Choice"}}},"Camt029Charges15":{"type":"object","properties":{"TtlChrgsAndTaxAmt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"Rcrd":{"type":"array","items":{"$ref":"#/components/schemas/Camt029ChargesRecord8"}}}},"Camt029ChargesRecord8":{"type":"object","properties":{"Amt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"},"CdtDbtInd":{"type":"string","enum":["CRDT","DBIT"]},"ChrgInclInd":{"type":"boolean"},"Tp":{"$ref":"#/components/schemas/Camt029ChargeType3Choice"},"Rate":{"type":"number"},"Br":{"type":"string","enum":["DEBT","CRED","SHAR","SLEV"]},"Agt":{"$ref":"#/components/schemas/Camt029BranchAndFinancialInstitutionIdentification8"},"Tax":{"$ref":"#/components/schemas/Camt029TaxCharges2"}},"required":["Amt"]},"Camt029TaxCharges2":{"type":"object","properties":{"Id":{"type":"string","minLength":1,"maxLength":35},"Rate":{"type":"number"},"Amt":{"$ref":"#/components/schemas/Camt029ActiveOrHistoricCurrencyAndAmount"}}},"Camt029CorrectiveTransaction5Choice":{"type":"object"},"Camt029SupplementaryData1":{"type":"object","properties":{"PlcAndNm":{"type":"string","minLength":1,"maxLength":350},"Envlp":{"$ref":"#/components/schemas/Camt029SupplementaryDataEnvelope1"}},"required":["Envlp"]},"Camt029SupplementaryDataEnvelope1":{"type":"object"},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/camt029":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 camt.029 Resolution of Investigation","description":"Submit an ISO 20022 camt.029 resolution of investigation response. Nexus validates and correlates the resolution against the outstanding camt.056 cancellation in its journal by OrgnlUETR. Validation or correlation failures are surfaced via the Nexus Operations Service Desk.","operationId":"submitCamt029","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 camt.029.001.13 XML payload. Validated against the camt.029.001.13 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Camt029Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"409":{"description":"Conflict. This request was already accepted and is still being processed. Do not retry - use a pacs.028 status request to check the outcome."},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```

## Submit an ISO 20022 admi.004 System Event (downtime) Notification

> Submit an ISO 20022 admi.004 System Event Notification announcing a Direct Participant IPS's own downtime (EvtCd one of PIDN, SIDN, UIDN, EIDN). Nexus validates the message schema synchronously and returns 202 Accepted, then processes the body asynchronously. Any post-202 rejection is delivered out-of-band as an admi.002 to the IPS's admi.002 endpoint resolved from CAP reference data. Transport security requires mutual TLS: Nexus validates the caller's client certificate against the IPS certificate registered in CAP; the IPS identity is taken from that certificate, so no response endpoint is supplied on the request.

```json
{"openapi":"3.1.0","info":{"title":"Nexus API","version":"v1"},"tags":[{"name":"ISO 20022 Messages","description":"Accepts an ISO 20022 message in XML format, prepared according to the Nexus Message Usage Guidelines. The messagePath path parameter selects the message type."}],"servers":[{"url":"http://localhost:8080","description":"Local simulator (make run / make docker-run)"},{"url":"https://nexus-ai-simulator-683365449922.asia-southeast1.run.app","description":"Deployed simulator (Cloud Run, asia-southeast1) - indicative, not authoritative"}],"security":[{"nexusOAuth":["admin.downtime.notify"]}],"components":{"securitySchemes":{"nexusOAuth":{"type":"oauth2","description":"OAuth2 client credentials token issued per participant.","flows":{"clientCredentials":{"tokenUrl":"https://auth.nexus.net/realms/nexus/protocol/openid-connect/token","scopes":{"countries.read":"Read country and currency reference data","address.read":"Read address types and input definitions","institutions.read":"Read the financial institution directory","quotes.read":"Retrieve FX quotes for a corridor and amount","quote.read":"Compute fees and settlement amounts from a PSP supplied rate","fees.read":"Retrieve the Destination Agent fee formula","payment.process":"Submit and receive ISO 20022 payment messages","admin.downtime.notify":"Submit admi.004 downtime notifications for a Direct Participant IPS","fxp.payment.read":"Query the FXP's own completed payments","rates.read":"Read FXP rate records.","rates.write":"Create or withdraw FXP rate records.","tiers.read":"Read FXP tier records.","tiers.write":"Create or withdraw FXP tier records.","relationships.read":"Read FXP–PSP relationship records.","relationships.write":"Create, update, or delete FXP–PSP relationship records."}}}}},"schemas":{"Admi004Document":{"type":"object","properties":{"SysEvtNtfctn":{"$ref":"#/components/schemas/Admi004SystemEventNotificationV02"}},"required":["SysEvtNtfctn"],"xml":{"name":"Document"}},"Admi004SystemEventNotificationV02":{"type":"object","properties":{"EvtInf":{"$ref":"#/components/schemas/Admi004Event2"}},"required":["EvtInf"]},"Admi004Event2":{"type":"object","properties":{"EvtCd":{"type":"string","pattern":"[a-zA-Z0-9]{1,4}","minLength":1,"maxLength":4},"EvtParam":{"type":"array","items":{"type":"string","minLength":1,"maxLength":35}},"EvtDesc":{"type":"string","minLength":1,"maxLength":1000},"EvtTm":{"type":"string","format":"date-time"}},"required":["EvtCd"]},"ErrorApiResponse":{"type":"object","description":"Standard structured rejection body. Returned for all non-2xx responses produced by the auth sidecar or the application. Gateway level errors (405, 409, 413, 429, 502, 503, 504) do NOT carry this body.","properties":{"statusCode":{"type":"string","description":"Business-level status code. Always RJCT (Rejected) — the structured error body is only returned for rejection cases. Successful responses use HTTP status alone (200 OK for sync, 202 Accepted for async ingress) with no structured statusCode body.","enum":["RJCT"],"maxLength":4},"reasonCode":{"type":"string","description":"Categorised reason code. Three families: TE (Technical Error, e.g. TE001/TE002/TE099), AE (Authentication / Authorization Error, e.g. AE001–AE004, sidecar-enforced), BE (Business Error). BE001–BE020 are raised by the Payments endpoints; BE021–BE027 are raised by the FXP endpoints.","enum":["AE001","AE002","AE003","AE004","BE001","BE002","BE005","BE006","BE007","BE008","BE009","BE011","BE012","BE016","BE017","BE018","BE019","BE020","BE021","BE022","BE023","BE024","BE025","BE026","BE027","TE001","TE002","TE099"],"maxLength":5,"pattern":"[A-Z]{2}[0-9]{3}"},"name":{"type":"string","description":"Machine-readable business error name from the reason code catalogue.","maxLength":50,"pattern":"[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*"},"description":{"type":"string","description":"Human-readable error description. MUST NOT contain PII (CD-INV-09).","maxLength":500}},"required":["description","name","reasonCode","statusCode"]}}},"paths":{"/iso20022/admi004":{"post":{"tags":["ISO 20022 Messages"],"summary":"Submit an ISO 20022 admi.004 System Event (downtime) Notification","description":"Submit an ISO 20022 admi.004 System Event Notification announcing a Direct Participant IPS's own downtime (EvtCd one of PIDN, SIDN, UIDN, EIDN). Nexus validates the message schema synchronously and returns 202 Accepted, then processes the body asynchronously. Any post-202 rejection is delivered out-of-band as an admi.002 to the IPS's admi.002 endpoint resolved from CAP reference data. Transport security requires mutual TLS: Nexus validates the caller's client certificate against the IPS certificate registered in CAP; the IPS identity is taken from that certificate, so no response endpoint is supplied on the request.","operationId":"submitAdmi004","parameters":[{"name":"Content-Type","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"application/xml","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Raw ISO 20022 admi.004.001.02 XML payload. Validated against the admi.004.001.02 XSD.\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Admi004Document"}}},"required":true},"responses":{"202":{"description":"Message accepted at the Ack0 boundary and stored for async processing. Not final business acceptance - failures are sent later via an ISO 20022 message (e.g. admi.002)."},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"405":{"description":"Method Not Allowed. The HTTP method is not supported for this endpoint. Use the correct HTTP method.","headers":{"Allow":{"description":"Permitted HTTP methods for this endpoint","schema":{"type":"string"}}}},"413":{"description":"Payload Too Large. The request body exceeds the gateway's maximum allowed size. Reduce payload size or check gateway configuration."},"429":{"description":"Too Many Requests. Rate limit exceeded. The Retry-After header indicates when to retry. Back off and retry after the indicated duration.","headers":{"Retry-After":{"description":"Duration after which the caller may retry","schema":{"type":"string"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"502":{"description":"Bad Gateway. The gateway received an invalid response from the upstream service. Retry with exponential backoff. If persistent, escalate."},"503":{"description":"Service Unavailable. The upstream service is temporarily unavailable, for example during rolling deployment. Retry with exponential backoff."},"504":{"description":"Gateway Timeout. The upstream service did not respond within the gateway's timeout window. Retry with exponential backoff."}}}}}}
```