Swift Messaging API
Number of APIs: 81
"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 and InterAct services supported by Alliance Cloud. Upload and download endpoints are available per SWIFT service (FIN, InterAct), 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." Contact Support:
Name: Standards & Developer Hub
Email: developer-support@swift.com
1. Authorization - Refresh Token
POST https://sandbox.swift.com/oauth2/v1/token
Used for obtaining JWT token based on clientid and secretkey.
2. v1-distributions-{id} - Retrieve a single available distribution from Alliance Cloud.
GET {{baseUrl}}/alliancecloud/v1/distributions/:id
This operations enables retrieving a single available distribution from Alliance Cloud, providing its id. The DN used to perform the OAuth process with SWIFT API Gateway is the one used to link the request to an application channel in Alliance Cloud.
3. v1-distributions-{id} - ACK a distribution.
POST {{baseUrl}}/alliancecloud/v1/distributions/:id/acks
Send a ACK information about a distribution. A valid ACK on a distribution will remove the distribution from the list of available distributions, and mark the distribution as 'distributed' in Alliance Cloud. The request body include properties that will be used for non-repudiation reasons
4. v1-distributions-{id} - NAK a distribution.
POST {{baseUrl}}/alliancecloud/v1/distributions/:id/naks
Send a NAK information about a distribution. A valid NAK on a distribution will remove the distribution from the list of available distributions, and mark the distribution as 'failed to be distributed' in Alliance Cloud.
5. v1-distributions - Retrieve the list of available distributions from Alliance Cloud.
GET {{baseUrl}}/alliancecloud/v1/distributions
This operation enables retrieving the list of available distributions for download from Alliance Cloud. The DN used to perform the OAuth process with SWIFT API Gateway is the one used to link the request to an application channel in Alliance Cloud.
6. v1-distributions - Update the status of multiple distributions in Alliance Cloud.
PATCH {{baseUrl}}/alliancecloud/v1/distributions
This operation enables updating the status of several distributions in a single API call. Updates to the status for each distribution can either be 'Ack' or 'Nak'. In case of a 'Nak', an optional message describing the reason for the NAK can be specified. If specified in an 'Ack' status update, the message will be ignored
7. v1-fin-messages - Download one or several FIN messages ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/messages?distributionId=95064307,76245508
Retrieve FIN messages using one or several distributionId's
8. v1-fin-messages - Send a FIN message to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v1/fin/messages
This operations enables sending a FIN message to Alliance Cloud
9. v1-fin-messages - Send a batch of FIN messages to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v1/fin/messages/batch
This operation enables sending multiple FIN messages to Alliance Cloud, in a single API call. For a given batch request, every single message must have its senderreference field present and not empty. All senderreference values from the message items must be unique inside a given batch request. A maximum of 500 FIN messages can be sent in one call.
10. v1-fin-messages - Download a FIN message ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/messages/:distributionId
Retrieve a FIN message using its distributionId
11. v1-fin-transmission-reports - Download one or several FIN transmission reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/transmission-reports?distributionId=95064307,76245508
Retrieve FIN transmission reports using one or several distributionId's
12. v1-fin-transmission-reports - Download a FIN transmission report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/transmission-reports/:distributionId
Retrieve a FIN transmission report using its distributionId
13. v1-fin-delivery-reports - Download one or several FIN delivery reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/delivery-reports?distributionId=95064307,76245508
Retrieve FIN delivery reports using one or several distributionId's
14. v1-fin-delivery-reports - Download a FIN Delivery report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/delivery-reports/:distributionId
Retrieve a FIN Delivery report using its distributionId
15. v1-fin-delivery-notifications - Download one or several FIN delivery notifications ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/delivery-notifications?distributionId=95064307,76245508
Retrieve FIN delivery notifications using one or several distributionId's
16. v1-fin-delivery-notifications - Download a FIN Delivery notification ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fin/delivery-notifications/:distributionId
Retrieve a FIN Delivery notification using its distributionId
17. v1-interact-messages - Download one or several InterAct messages ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/messages?distributionId=95064307,76245508
Retrieve InterAct messages using one or several distributionId's
18. v1-interact-messages - Send an InterAct message to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v1/interact/messages
This operations enables sending an InterAct message to Alliance Cloud
19. v1-interact-messages - Send a batch of InterAct messages to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v1/interact/messages/batch
This operation enables sending multiple InterAct messages to Alliance Cloud, in a single API call. For a given batch request, every single message must have its senderreference fields present and not empty. All senderreference values from the message items must be unique inside a given batch request. A maximum of 50 InterAct messages can be sent in one call.
20. v1-interact-messages - Download an InterAct message ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/messages/:id
Retrieve an InterAct message using its distributionId
21. v1-interact-transmission-reports - Download one or several InterAct transmission reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/transmission-reports?distributionId=95064307,76245508
Retrieve InterAct transmission reports using one or several distributionId's
22. v1-interact-transmission-reports - Download an InterAct transmission report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/transmission-reports/:id
Retrieve an InterAct transmission report using its distributionId
23. v1-interact-delivery-reports - Download one or several InterAct delivery reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/delivery-reports?distributionId=95064307,76245508
Retrieve InterAct delivery reports using one or several distributionId's
24. v1-interact-delivery-reports - Download an InterAct delivery report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/delivery-reports/:id
Retrieve an InterAct delivery report using its distributionId
25. v1-interact-delivery-notifications - Download one or several InterAct delivery notifications ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/delivery-notifications?distributionId=95064307,76245508
Retrieve InterAct delivery notifications using one or several distributionId's
26. v1-interact-delivery-notifications - Download an InterAct delivery notification ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/interact/delivery-notifications/:id
Retrieve an InterAct delivery notification using its distributionId
27. v1-fileact-messages - This operation initiates the sending of a FileAct message.
POST {{baseUrl}}/alliancecloud/v1/fileact/messages
Initiate the sending of a FileAct message to Alliance Cloud. In this operation, the FileAct SwiftNet metadata (companion) is sent alongside the FileAct payload transfer negotiation information. The response to this request contains the necessary information to leverage a signed URL to perform the FileAct payload upload, as well as a unique transfer identifier that will be used to complete the FileAct sending.
28. v1-fileact-messages - This operation completes the whole sending process for a FileAct message.
POST {{baseUrl}}/alliancecloud/v1/fileact/messages/:transferId/acks
After having initiated a FileAct message upload, and sent the payload using the signed URL, this endpoint must be used to complete the operation, notifying Alliance Cloud that the payload upload is done. This operation will actually create the FileAct message in Alliance Cloud and give back its message cloud reference in its response.
29. v1-fileact-messages - This operation initiates the download of a FileAct message.
POST {{baseUrl}}/alliancecloud/v1/fileact/messages/:distributionId
Knowing the distribution ID for a FileAct message to download, this operation can be used to both receive the FileAct metadata (companion) information and initiate the FileAct payload download tranfer.
30. v1-fileact-messages - Mock Download
GET {{signedDownload}}
31. v1-fileact-messages - Mock Upload
PUT {{signedUpload}}
32. v1-fileact-transmission-reports - Download one or several FileAct transmission reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fileact/transmission-reports?distributionId=44984186577
Retrieve FileAct transmission reports using one or several distributionId's
33. v1-fileact-transmission-reports - Download a FileAct transmission report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fileact/transmission-reports/:distributionId
Retrieve a FileAct transmission report using its distributionId
34. v1-fileact-delivery-reports - Download one or several FileAct delivery reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fileact/delivery-reports?distributionId=44984186577
Retrieve FileAct delivery reports using one or several distributionId's
35. v1-fileact-delivery-reports - Download a FileAct delivery report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v1/fileact/delivery-reports/:distributionId
Retrieve a FileAct delivery report using its distributionId
36. v2-distributions-{id} - Retrieve a single available distribution from Alliance Cloud.
GET {{baseUrl}}/alliancecloud/v2/distributions/:id
This operations enables retrieving a single available distribution from Alliance Cloud, providing its id. The DN used to perform the OAuth process with SWIFT API Gateway is the one used to link the request to an application channel in Alliance Cloud.
37. v2-distributions-{id} - ACK a distribution.
POST {{baseUrl}}/alliancecloud/v2/distributions/:id/acks
Send a ACK information about a distribution. A valid ACK on a distribution will remove the distribution from the list of available distributions, and mark the distribution as 'distributed' in Alliance Cloud. The request body include properties that will be used for non-repudiation reasons
38. v2-distributions-{id} - NAK a distribution.
POST {{baseUrl}}/alliancecloud/v2/distributions/:id/naks
Send a NAK information about a distribution. A valid NAK on a distribution will remove the distribution from the list of available distributions, and mark the distribution as 'failed to be distributed' in Alliance Cloud.
39. v2-distributions - Retrieve the list of available distributions from Alliance Cloud.
GET {{baseUrl}}/alliancecloud/v2/distributions
This operation enables retrieving the list of available distributions for download from Alliance Cloud. The DN used to perform the OAuth process with SWIFT API Gateway is the one used to link the request to an application channel in Alliance Cloud.
40. v2-distributions - Update the status of multiple distributions in Alliance Cloud.
PATCH {{baseUrl}}/alliancecloud/v2/distributions
This operation enables updating the status of several distributions in a single API call. Updates to the status for each distribution can either be 'Ack' or 'Nak'. In case of a 'Nak', an optional message describing the reason for the NAK can be specified. If specified in an 'Ack' status update, the message will be ignored
41. v2-fin-messages - Download one or several FIN messages ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/messages?distribution-id=44984189499,44984189459
Retrieve FIN messages using one or several distribution ID's
42. v2-fin-messages - Send a FIN message to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v2/fin/messages
This operations enables sending a FIN message to Alliance Cloud
43. v2-fin-messages - Send a batch of FIN messages to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v2/fin/messages/batch
This operation enables sending multiple FIN messages to Alliance Cloud, in a single API call. For a given batch request, every single message must have its senderreference field present and not empty. All senderreference values from the message items must be unique inside a given batch request. A maximum of 500 FIN messages can be sent in one call.
44. v2-fin-messages - Download a FIN message ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/messages/:distribution-id
Retrieve a FIN message using its distribution ID
45. v2-fin-transmission-reports - Download one or several FIN transmission reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/transmission-reports?distribution-id=44984189500
Retrieve FIN transmission reports using one or several distribution ID's
46. v2-fin-transmission-reports - Download a FIN transmission report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/transmission-reports/:distribution-id
Retrieve a FIN transmission report using its distribution ID
47. v2-fin-delivery-reports - Download one or several FIN delivery reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/delivery-reports?distribution-id=44984189500
Retrieve FIN delivery reports using one or several distribution ID's
48. v2-fin-delivery-reports - Download a FIN Delivery report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/delivery-reports/:distribution-id
Retrieve a FIN Delivery report using its distribution ID
49. v2-fin-delivery-notifications - Download one or several FIN delivery notifications ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/delivery-notifications?distribution-id=44984189500
Retrieve FIN delivery notifications using one or several distribution ID's
50. v2-fin-delivery-notifications - Download a FIN Delivery notification ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/delivery-notifications/:distribution-id
Retrieve a FIN Delivery notification using its distribution ID
51. v2-fin-archives - Download one or several FIN archives ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/archives?distribution-id=54043195528446210,54043195528446210
Retrieve FIN archives using one or several distribution ID's
52. v2-fin-archives - Download a FIN archive ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/archives/:distribution-id
Retrieve a FIN archive using its distribution ID
53. v2-fin-exports - Download one or several FIN message exports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/exports?distribution-id=54043195528446260,54043195528446260
Retrieve FIN exports using one or several distribution ID's
54. v2-fin-exports - Download a FIN export ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fin/exports/:distribution-id
Retrieve a FIN export using its distribution ID
55. v2-interact-messages - Download one or several InterAct messages ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/messages?distribution-id=44984189499
Retrieve InterAct messages using one or several distribution ID's
56. v2-interact-messages - Send an InterAct message to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v2/interact/messages
This operations enables sending an InterAct message to Alliance Cloud
57. v2-interact-messages - Send a batch of InterAct messages to Alliance Cloud.
POST {{baseUrl}}/alliancecloud/v2/interact/messages/batch
This operation enables sending multiple InterAct messages to Alliance Cloud, in a single API call. For a given batch request, every single message must have its senderreference fields present and not empty. All senderreference values from the message items must be unique inside a given batch request. A maximum of 50 InterAct messages can be sent in one call.
58. v2-interact-messages - Download an InterAct message ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/messages/:distribution-id
Retrieve an InterAct message using its distribution ID
59. v2-interact-transmission-reports - Download one or several InterAct transmission reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/transmission-reports?distribution-id=44984189499
Retrieve InterAct transmission reports using one or several distribution ID's
60. v2-interact-transmission-reports - Download an InterAct transmission report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/transmission-reports/:distribution-id
Retrieve an InterAct transmission report using its distribution ID
61. v2-interact-delivery-reports - Download one or several InterAct delivery reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/delivery-reports?distribution-id=44984189499
Retrieve InterAct delivery reports using one or several distribution ID's
62. v2-interact-delivery-reports - Download an InterAct delivery report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/delivery-reports/:distribution-id
Retrieve an InterAct delivery report using its distribution ID
63. v2-interact-delivery-notifications - Download one or several InterAct delivery notifications ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/delivery-notifications?distribution-id=44984189499
Retrieve InterAct delivery notifications using one or several distribution ID's
64. v2-interact-delivery-notifications - Download an InterAct delivery notification ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/delivery-notifications/:distribution-id
Retrieve an InterAct delivery notification using its distribution ID
65. v2-interact-archives - Download one or several InterAct archives ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/archives?distribution-id=44984189489
Retrieve InterAct archives using one or several distribution ID's
66. v2-interact-archives - Download an InterAct archive ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/archives/:distribution-id
Retrieve an InterAct archive using its distribution ID
67. v2-interact-exports - Download one or several InterAct message exports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/exports?distribution-id=54043195528446450,54043195528446450
Retrieve InterAct exports using one or several distribution ID's
68. v2-interact-exports - Download an InterAct export ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/interact/exports/:distribution-id
Retrieve a InterAct export using its distribution ID
69. v2-fileact-transfers - This operation initiates the transfer of a FileAct message.
POST {{baseUrl}}/alliancecloud/v2/fileact/transfers
Initiate the transfer of a FileAct message to Alliance Cloud. In this operation, the FileAct SwiftNet metadata (companion) is sent alongside the FileAct payload transfer negotiation information. The response to this request contains the necessary information to leverage a signed URL to perform the FileAct payload upload, as well as a unique transfer identifier that will be used to complete the FileAct sending.
70. v2-fileact-transfers - This operation completes the whole sending process for a FileAct message.
POST {{baseUrl}}/alliancecloud/v2/fileact/transfers/:transfer-id/acks
After having initiated a FileAct message transfer, and sent the payload using the signed URL, this endpoint must be used to complete the operation, notifying Alliance Cloud that the payload upload is done. This operation will actually create the FileAct message in Alliance Cloud and give back its message cloud reference in its response.
71. v2-fileact-transfers - Mock Upload
PUT {{signedUpload}}
72. v2-fileact-messages - This operation initiates the download of a FileAct message.
POST {{baseUrl}}/alliancecloud/v2/fileact/messages/:distribution-id
Knowing the distribution ID for a FileAct message to download, this operation can be used to both receive the FileAct metadata (companion) information and initiate the FileAct payload download transfer.
73. v2-fileact-messages - Mock Download
GET {{signedDownload}}
74. v2-fileact-transmission-reports - Download one or several FileAct transmission reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fileact/transmission-reports?distribution-id=44984186577
Retrieve FileAct transmission reports using one or several distribution ID's
75. v2-fileact-transmission-reports - Download a FileAct transmission report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fileact/transmission-reports/:distribution-id
Retrieve a FileAct transmission report using its distribution ID
76. v2-fileact-delivery-reports - Download one or several FileAct delivery reports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fileact/delivery-reports?distribution-id=44984186577
Retrieve FileAct delivery reports using one or several distribution ID's
77. v2-fileact-delivery-reports - Download a FileAct delivery report ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fileact/delivery-reports/:distribution-id
Retrieve a FileAct delivery report using its distribution ID
78. v2-fileact-archives - This operation initiates the download of a FileAct archive.
POST {{baseUrl}}/alliancecloud/v2/fileact/archives/:distribution-id
Knowing the distribution ID for a FileAct archive to download, this operation can be used to both receive the archive with the FileAct metadata (companion) information, along with the available reports for this archive, and initiate the FileAct payload download transfer.
79. v2-fileact-exports - Download one or several FileAct message exports ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fileact/exports?distribution-id=54043195528446840,54043195528446840
Retrieve FileAct exports using one or several distribution ID's
80. v2-fileact-exports - Download an FileAct export ready to be distributed.
GET {{baseUrl}}/alliancecloud/v2/fileact/exports/:distribution-id
Retrieve a FileAct export using its distribution ID
81. Teardown - Revoke Token
POST https://sandbox.swift.com/oauth2/v1/revoke
Used for revoking JWT token based on clientid and secretkey.
ENDPOINTS