Fee Statistics API (Payment Experience PoV)
Number of APIs: 3
Legal disclaimer This API is provided in the context of the Payment Experience Proof of Value (PoV) and is currently under exploration. Its use is only allowed to PoV participants, in accordance with the Customer Consultation Terms and Conditions. The provision of the API specifications, documentation and other artifacts should not be taken as an indication of intent on the part of SWIFT or any of its subsidiaries to develop any products or services directly based on the subject matter. This API and related artifacts and documentation may not be interpreted as a decision by SWIFT to commercially launch any or all described services. This API provides end user insights at payment initiation and aims at enhancing end customer (upfront) predictability of cross-border payments. A requestor agent can use it to obtain statistics for past payments it sent to a specific creditor agent. These statistics are related to the end-to-end transactions fees (deducts), creditor agent fees (deducts) and processing time, based on past Swift transaction data. The requestor agent decides whether to provide the obtained statistics to the end user based on the statistics confidence level. The requestor agent would initiate the payment once approved by the end user.
1. Authorization - Refresh Token
POST https://sandbox.swift.com/oauth2/v1/token
Used for obtaining JWT token based on clientid and secretkey.
2. v1 - Example with creditor agent using a domestic identification
POST {{baseUrl}}/swift-preval/FeeStatistics/v1/payments/fee-statistics
This API provides end user insights at payment initiation and aims at enhancing end customer (upfront) predictability of cross-border payments. A requestor agent can use it to obtain statistics for past payments it sent to a specific creditor agent. These statistics are related to the end-to-end transactions fees (deducts), creditor agent fees (deducts) and processing time, based on past Swift transaction data. The requestor agent decides whether to provide the obtained statistics to the end user based on the statistics confidence level. The requestor agent would initiate the payment once approved by the end user.
3. Teardown - Revoke Token
POST https://sandbox.swift.com/oauth2/v1/revoke
Used for revoking JWT token based on clientid and secretkey.
ENDPOINTS