SWIFT Reporting API

openapi: 3.2.0
info:
  title: Cash Management Reporting API
  description: 'The API is used by the consumer of the API to get account information and reporting of global, multi-country Account statement and Debit/Credit entries. At any time during the operating hours of the system, the account owner can request to get information about the account(s) that the account servicer maintains for the member. For example, this may be necessary in order to perform the appropriate liquidity management and the funds transfers between accounts. The API currently supports endpoint to get entries reported to the account, and/or to provide the owner with balance information on the account at a given point in time.


    `The API supports following functionalities:`


    * Retrieve list of account with balance information

    * Retrieve details of a specific account

    * Retrieve debit/credit entries reported to the account pending and booked items on the account at a given point in time to enable intraday reconciliation

    * Get account statement by the account owner, or authorised party, of the entries booked to the account, and to provide the owner with balance information on the account at a given point in time


    `Error Responses`


    The API uses common HTTP status codes in the response header to indicate success or failure. Specific error code and description will be returned in the custom error schema.


    `Query Parameters`


    Each URL query parameter specifies an API query parameter that must be URL encoded.


    **v1.0.9 Release Notes**

    * All schema object containing "oneOf" syntax is updated to align with open API specification.

    * The header parameter X-ServiceProvider will be changed to X-UserContext.

    * PostalAddressUnstructured.country has been changed to optional.

    * An element CashAccount41.alternate_identification is added as a resource identifier where account identification cannot be used as a resource identification.

    * The element CashAccount41.linked_account is changed to CashAccount41.related_account.

    * The elements CashCurrentBalance1.balance_type, CashAvailableBalance1.balance_type, CashForwardAvailableBalance1.balance_type has been dropped.

    * Batch indicator block to statement lines is added.

    * Return information block is added to Statement.

    * The charges block is added to Statement Entry details level.

    * The size of the element "identification" in both Statements and Statement Lines has been increased to 36 from 35 to accommodate UUID.


    **v1.0.8 Release Notes**

    * The query parameter account-servicer is added to the getAccounts endpoint.

    * Party identification object (Organisation/Person) in Statements and Statement Lines is changed to ISO component style. This is to address use case where identification of object is not always possible when only party name is available.

    * Account Identification in Statements and Statement Lines is aligned with ISO component.

    * Remittance Information, Purpose and Bank Transaction Code is added to Statement Lines.

    * The element interest, related_account is added to Statements'
  contact:
    name: Standards & Developer Hub
    url: https://developer.swift.com
    email: developer-support@swift.com
  license:
    name: Community API Redistribution License
    url: https://www.swift.com/swift-resource/251146/download
  version: 1.0.9
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/SWIFT-API/corporate-to_bank_account_balance_information/1.0.9
- description: URL for Sandbox Environment.
  url: https://sandbox.swift.com/swift-cash-management/v1
- description: URL for Pilot.
  url: https://api-test.swiftnet.sipn.swift.com/swift-cash-management-pilot/v1
- description: URL for Live.
  url: https://api.swiftnet.sipn.swift.com/swift-cash-management/v1
security:
- oauthBearerToken: []
tags:


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