SWIFT Interact API

openapi: 3.2.0
info:
  title: Swift Messaging Interact API
  description: 'The Swift Messaging API enables your Back office applications to communicate with any SWIFT counterparty through Alliance Cloud by embedding SWIFT messages inside API calls, which offers easy and direct integration with Alliance Cloud via standard RESTful connectivity.


    The Swift Messaging API is the brand new connectivity feature designed for our Alliance Cloud customers and provides bidirectional flows for Back Offices to exchange messages (including copy of messages, transmission reports, delivery reports, delivery notifications) with Alliance Cloud, via RESTful APIs. So now you can use APIs to leverage the wide range of messaging services available on SWIFT – including all the FIN, InterAct, and FileAct services supported by Alliance Cloud. Upload and download endpoints are available per SWIFT service (FIN, InterAct, FileAct), while retrieving the list of available messages to be downloaded is available agnostically for all services.


    The Swift Messaging API supports batching for both sending and receiving messages (FIN and InterAct only).


    Release Notes


    Changes made since version 1.1.0:


    * Version in URLs updated to v2 (instead of v1)


    * Two new values for ''distribution_type'' available: ''archive'' and ''export''


    * Add ''export_content'' and ''export_format'' properties for a distribution, available when the distribution_type is ''export''


    * Introduce endpoints for downloading archive distributions


    * Introduce endpoints for downloading distributions of message exports


    * ''version'' field available for received FIN, InterAct, and FileAct message and companion_info objects


    * ''syntax_version'' field available for received FIN messages, inside the network_info object


    * Update FileAct transmission report and delivery report objects ''message'' property to ''companion_info''


    * Update ''mirs_balance_checkpoint_date_time'', ''local_output_time'', and ''message_input_time'' FIN fields type from date-time to plain string (14 characters). These fields carry local time information set by FIN for which the exact used time zone cannot be known. Format: ''yyyyMMddHHmmss'', example value: ''20230725105547''


    * Rename ''distributionId'' query parameter to ''distribution-id''


    * 404 error responses now carry the same JSON format (instead of plain text ''Not found'') as other error responses


    * Update FileAct upload transfer initiation endpoint URL from ''POST /fileact/messages'' to ''POST /fileact/transfers''


    * Update FileAct upload transfer ACK endpoint URL from ''/fileact/messages/{transfer-id}/acks'' to ''/fileact/transfers/{transfer-id}/acks'''
  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: 2.0.0
servers:
- url: https://virtserver.swaggerhub.com/SWIFT-API/Swift-Messaging/2.0.0
  description: SwaggerHub API Auto Mocking
- url: https://api-test.swiftnet.sipn.swift.com/alliancecloud-test/v2
  description: Test environment
- url: https://api.swiftnet.sipn.swift.com/alliancecloud/v2
  description: Production environment
- url: https://sandbox.swift.com/alliancecloud/v2
  description: Sandbox environment
security:
- oauthBearerToken: []
tags:


# --- truncated at 32 KB (271 KB total) ---
# Full source: https://artifacts.apis.io/swift/openapi/swift-interact-api-openapi.yml