# Swift gpi Tracker Schemas # Auto-generated from GpiAPI_to_Appian_Mappings.json # Total schemas: 20 openapi: '3.0.3' info: title: Swift gpi Tracker API Schemas version: '1.0.0' description: Auto-generated OpenAPI schemas for the Swift gpi Tracker services. paths: {} components: schemas: GpiResponse_ERROR: type: object properties: errorOccurred: type: string severity: type: string errorCode: type: string error: type: string userMessage: type: string moreInfo: type: string description: Response payload for ERROR returned by the Swift gpi Tracker. GpiPathParams_CCT_STATUS_UPDATE: type: object properties: uetr: type: string description: Path parameters for CCT-STATUS-UPDATE requests. GpiRequest_CCT_STATUS_UPDATE: type: object properties: from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. transactionStatus: type: string transactionStatusDate: type: string transactionStatusReason: type: string rejectReturnReason: type: string trackerInformingParty: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. instructionIdentification: type: string serviceLevel: type: string paymentScenario: type: string settlementMethod: type: string clearingSystem: type: string instructedAgent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. clearingSystemMemberIdentification: type: object properties: clearingSystemIdentification: type: string memberIdentification: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string sourceCurrency: type: string targetCurrency: type: string exchangeRate: type: string chargeBearer: type: string chargesInformation: type: array maxItems: 200 items: type: object properties: amount: type: object properties: currency: type: string amount: type: string agent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. name: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string remainingToBeConfirmedAmount: type: object properties: currency: type: string amount: type: string previouslyConfirmedAmount: type: object properties: currency: type: string amount: type: string description: Request payload for CCT-STATUS-UPDATE sent to the Swift gpi Tracker. GpiResponse_CCT_STATUS_UPDATE: type: object properties: success: type: string description: Response payload for CCT-STATUS-UPDATE returned by the Swift gpi Tracker. GpiPathParams_COV_STATUS_UPDATE: type: object properties: uetr: type: string description: Path parameters for COV-STATUS-UPDATE requests. GpiRequest_COV_STATUS_UPDATE: type: object properties: from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. transactionStatus: type: string transactionStatusDate: type: string transactionStatusReason: type: string rejectReturnReason: type: string trackerInformingParty: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. instructionIdentification: type: string endToEndIdentification: type: string serviceLevel: type: string paymentScenario: type: string settlementMethod: type: string clearingSystem: type: string instructedAgent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. clearingSystemMemberIdentification: type: object properties: clearingSystemIdentification: type: string memberIdentification: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string description: Request payload for COV-STATUS-UPDATE sent to the Swift gpi Tracker. GpiResponse_COV_STATUS_UPDATE: type: object properties: success: type: string description: Response payload for COV-STATUS-UPDATE returned by the Swift gpi Tracker. GpiPathParams_FIT_STATUS_UPDATE: type: object properties: uetr: type: string description: Path parameters for FIT-STATUS-UPDATE requests. GpiRequest_FIT_STATUS_UPDATE: type: object properties: from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. transactionStatus: type: string transactionStatusDate: type: string transactionStatusReason: type: string rejectReturnReason: type: string trackerInformingParty: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. instructionIdentification: type: string endToEndIdentification: type: string serviceLevel: type: array maxItems: 2 items: type: string paymentScenario: type: string settlementMethod: type: string clearingSystem: type: string instructedAgent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. clearingSystemMemberIdentification: type: object properties: clearingSystemIdentification: type: string memberIdentification: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string creditor: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAccount: type: object properties: iban: type: string identification: type: string purpose: type: string description: Request payload for FIT-STATUS-UPDATE sent to the Swift gpi Tracker. GpiResponse_FIT_STATUS_UPDATE: type: object properties: success: type: string description: Response payload for FIT-STATUS-UPDATE returned by the Swift gpi Tracker. GpiPathParams_UC_STATUS_UPDATE: type: object properties: uetr: type: string description: Path parameters for UC-STATUS-UPDATE requests. GpiRequest_UC_STATUS_UPDATE: type: object properties: from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. transactionStatus: type: string transactionStatusDate: type: string transactionStatusReason: type: string rejectReturnReason: type: string trackerInformingParty: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. instructionIdentification: type: string paymentScenario: type: string settlementMethod: type: string clearingSystem: type: string instructedAgent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. clearingSystemMemberIdentification: type: object properties: clearingSystemIdentification: type: string memberIdentification: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string sourceCurrency: type: string targetCurrency: type: string exchangeRate: type: string chargeBearer: type: string chargesInformation: type: array maxItems: 200 items: type: object properties: amount: type: object properties: currency: type: string amount: type: string agent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. name: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string description: Request payload for UC-STATUS-UPDATE sent to the Swift gpi Tracker. GpiResponse_UC_STATUS_UPDATE: type: object properties: success: type: string description: Response payload for UC-STATUS-UPDATE returned by the Swift gpi Tracker. GpiPathParams_PMI_STATUS_UPDATE: type: object properties: uetr: type: string description: Path parameters for PMI-STATUS-UPDATE requests. GpiRequest_PMI_STATUS_UPDATE: type: object properties: from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. transactionStatus: type: string transactionStatusDate: type: string transactionStatusReason: type: string rejectReturnReason: type: string trackerInformingParty: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. clearingSystemMemberIdentification: type: object properties: clearingSystemIdentification: type: string memberIdentification: type: string instructionIdentification: type: string endToEndIdentification: type: string serviceLevel: type: string paymentScenario: type: string instructedAgent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. clearingSystemMemberIdentification: type: object properties: clearingSystemIdentification: type: string memberIdentification: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string sourceCurrency: type: string targetCurrency: type: string exchangeRate: type: string chargeBearer: type: string chargesInformation: type: array maxItems: 200 items: type: object properties: amount: type: object properties: currency: type: string amount: type: string agent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. name: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string remainingToBeConfirmedAmount: type: object properties: currency: type: string amount: type: string previouslyConfirmedAmount: type: object properties: currency: type: string amount: type: string creditor: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAccount: type: object properties: iban: type: string identification: type: string description: Request payload for PMI-STATUS-UPDATE sent to the Swift gpi Tracker. GpiResponse_PMI_STATUS_UPDATE: type: object properties: success: type: string description: Response payload for PMI-STATUS-UPDATE returned by the Swift gpi Tracker. GpiPathParams_TRANSACTIONS_GET: type: object properties: uetr: type: string description: Path parameters for TRANSACTIONS-GET requests. GpiResponse_TRANSACTIONS_GET: type: object properties: uetr: type: string masterUetr: type: string subUetr: type: array maxItems: 200 items: type: string transactionStatus: type: string transactionStatusReason: type: string rejectReturnReason: type: string transactionCancellationStatus: type: string cases: type: string initiationDateTime: type: string completionDateTime: type: string lastUpdateDateTime: type: string eventsSkipped: type: string paymentEvents: type: array maxItems: 200 items: type: object properties: networkReference: type: string messageNameIdentification: type: string serviceLevel: type: array maxItems: 2 items: type: string trackerEventType: type: string valid: type: string invalidityReason: type: string invalidityDescription: type: string eventStatus: type: string eventStatusDate: type: string eventStatusReason: type: string eventRejectReturnReason: type: string amountInconsistency: type: string instructionIdentification: type: string endToEndIdentification: type: string trackedMessageIdentification: type: string masterUetr: type: string subUetr: type: array maxItems: 200 items: type: string caseIdentification: type: string originalInstructionIdentification: type: string assignmentIdentification: type: string cancellationRequestDetails: type: object properties: cancellationReasonInformation: type: string indemnityAgreement: type: string cancellationResponseDetails: type: object properties: investigationExecutionStatus: type: string investigationExecutionStatusReason: type: object properties: rejected: type: string pending: type: string cancellationRequestTrackingStatus: type: string trackerInformingParty: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. settlementMethod: type: string clearingSystem: type: string instructedAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. technicalSender: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. technicalReceiver: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. interbankSettlementDate: type: string instructedAmount: type: object properties: currency: type: string amount: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string sourceCurrency: type: string targetCurrency: type: string exchangeRate: type: string chargeBearer: type: string chargesInformation: type: array maxItems: 200 items: type: object properties: amount: type: object properties: currency: type: string amount: type: string agent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. name: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string remainingToBeConfirmedAmount: type: object properties: currency: type: string amount: type: string previouslyConfirmedAmount: type: object properties: currency: type: string amount: type: string purpose: type: string from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. to: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. instructingReimbursementAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. debtor: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. debtorAccount: type: object properties: iban: type: string identification: type: string debtorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditor: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAccount: type: object properties: iban: type: string identification: type: string underlyingCustomerCreditTransfer: type: object properties: debtorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. senderAcknowledgementReceiptDateTime: type: string receivedDateTime: type: string updatePayment: type: string duplicateMessageReference: type: string copiedBusinessService: type: string eventCreationDateTime: type: string description: Response payload for TRANSACTIONS-GET returned by the Swift gpi Tracker. GpiQueryParams_CHANGED_TRANSACTIONS_GET: type: object properties: fromDateTime: type: string toDateTime: type: string paymentScenario: type: string maximumNumber: type: string next: type: string description: Query parameters for CHANGED-TRANSACTIONS-GET requests. GpiResponse_CHANGED_TRANSACTIONS_GET: type: object properties: paymentTransactions: type: array maxItems: 100 items: type: object properties: uetr: type: string masterUetr: type: string subUetr: type: array maxItems: 200 items: type: string transactionStatus: type: string transactionStatusReason: type: string rejectReturnReason: type: string transactionCancellationStatus: type: string cases: type: string initiationDateTime: type: string completionDateTime: type: string lastUpdateDateTime: type: string eventsSkipped: type: string paymentEvents: type: array maxItems: 200 items: type: object properties: networkReference: type: string messageNameIdentification: type: string serviceLevel: type: array maxItems: 2 items: type: string trackerEventType: type: string valid: type: string invalidityReason: type: string invalidityDescription: type: string eventStatus: type: string eventStatusDate: type: string eventStatusReason: type: string eventRejectReturnReason: type: string amountInconsistency: type: string instructionIdentification: type: string endToEndIdentification: type: string trackedMessageIdentification: type: string masterUetr: type: string subUetr: type: array maxItems: 200 items: type: string caseIdentification: type: string originalInstructionIdentification: type: string assignmentIdentification: type: string cancellationRequestDetails: type: object properties: cancellationReasonInformation: type: string indemnityAgreement: type: string cancellationResponseDetails: type: object properties: investigationExecutionStatus: type: string investigationExecutionStatusReason: type: object properties: rejected: type: string pending: type: string cancellationRequestTrackingStatus: type: string trackerInformingParty: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. settlementMethod: type: string clearingSystem: type: string instructedAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. technicalSender: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. technicalReceiver: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. interbankSettlementDate: type: string instructedAmount: type: object properties: currency: type: string amount: type: string interbankSettlementAmount: type: object properties: currency: type: string amount: type: string sourceCurrency: type: string targetCurrency: type: string exchangeRate: type: string chargeBearer: type: string chargesInformation: type: array maxItems: 200 items: type: object properties: amount: type: object properties: currency: type: string amount: type: string agent: type: object properties: bicfi: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. name: type: string confirmedDate: type: string confirmedAmount: type: object properties: currency: type: string amount: type: string remainingToBeConfirmedAmount: type: object properties: currency: type: string amount: type: string previouslyConfirmedAmount: type: object properties: currency: type: string amount: type: string purpose: type: string from: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. to: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. instructingReimbursementAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. debtor: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. debtorAccount: type: object properties: iban: type: string identification: type: string debtorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditor: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAccount: type: object properties: iban: type: string identification: type: string underlyingCustomerCreditTransfer: type: object properties: debtorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. previousInstructingAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent1: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent2: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. intermediaryAgent3: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. creditorAgent: type: string pattern: "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$" description: BIC identifier. senderAcknowledgementReceiptDateTime: type: string receivedDateTime: type: string updatePayment: type: string duplicateMessageReference: type: string copiedBusinessService: type: string eventCreationDateTime: type: string nextCursor: type: string description: Response payload for CHANGED-TRANSACTIONS-GET returned by the Swift gpi Tracker.