SWIFT Get Payment Transaction Details API

openapi: 3.2.0
info:
  title: gpi API Transactions Get Payment Transaction Details API
  description: 'Retrieve status and payment events from the tracker


    *v6.0.0 Release Notes*


    * Introduction of new element MasterUetr and Subuetr both at transaction level as well as at payment event level to support the split payment process (see FIT rulebook for more information)

    * Introduction of new element named skipped indicator at transaction level which indicates that there are no payment events present due to schema compliance issues in payment messages involved in the transation.

    * Introduction of new code value SPLI in the Service level element (payment event level) in order to support the split payments process (see FIT rulebook for more information)

    * TransactionStatus, TransactionStatusDate, TransactionStatusReason, RejectReturnReason are replaced by EventStatus, EventStatusDate, EventStatusReason and EventRejectReturnReason respectively to clearly distinguish between those elements at payment event level and comparable elements at the transaction level of the GET API

    * Introduction of new element named TrackedMessageIdentification which may be present in the payment event related to a pacs.004 return that is being tracked and that does not contain an original instruction identification since the return is following a different route than the original underlying payment. The TrackedMessageIdentification allows in such case a better reconciliation between the pacs.004 and its related payment event. More information on this element in the rulebook sections related to returns

    * This contract does no longer contain the PUT Cancel Transaction and the PUT Transaction Cancellation Status APIs as a separate v6 contract has been created for those. Note that the v6 GET APIs in this contract still allow the user to obtain Stop and Recall information but it is recommended to use the GET v6 APIs in the specific Stop and Recall contract instead.

    * Introduction of new elements named TechnicalSender and TechnicalReceiver at payment event level that will be present for tracked pacs messages and reflect the technical header sender and receiver of the message. In the V-Shape MI context, these fields will allow to distinguish between a first leg from the bank to the MI and the second leg from the MI to the receiving bank.

    * Introduction of new element named Purpose Code which could be present with the value DEBT in case it is present in a pacs.009 settling charges payable by the debtor in relation to an underlying customer credit transfer (see FIT rulebook for more information)

    * Tracker Event Type RFTS which was missing in the enum in v5 has been added.

    * Last Update Date Time at Payment Event level was replaced by Event Creation Date Time

    * Introduction of new element named DebtorAccount. This element may be used in future but is conditional on approval of the necessary data access approvals


    v6.0.1 Release Notes*


    * Changed length of ExternalInvalidEventReasonCode back to 9 characters'
  contact:
    name: Standards & Developer Hub
    url: https://developer.swift.com
    email: developer-support@swift.com
  license:
    name: API Restricted License
    url: https://www.swift.com/file/56776/download?token=8w8DC4eF
  version: 6.0.1
servers:
- description: Test environment
  url: https://api-test.swiftnet.sipn.swift.com/swift-apitracker-pilot/v6
- description: Production environment
  url: https://api.swiftnet.sipn.swift.com/swift-apitracker/v6
- description: Sandbox environment
  url: https://sandbox.swift.com/swift-apitracker/v6
security:
- oauthBearerToken: []
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://artifacts.apis.io/swift/openapi/swift-get-payment-transaction-details-api-openapi.yml