Swift API Sandbox Collections API Documentation

Instant Cash Reporting API

Number of APIs: 7

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.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

v1.0.7 Release Notes

The query parameter account-identification is introduced to filter the result set of requested account for /accounts endpoint. The type of the element is an array of items (Max34Text) to support multiple values
The balance_type element of the object CashCurrentBalance1 is updated to support both CLBDclosingbookedand ITBDinterimbooked
The balance_type element of object the CashAvailableBalance1 is updated to support both CLAVclosingavailable and ITAVinterimavailable
The header element “X-BIC” is introduce for service provider routing
The element “CashAccount41.balances” is changed to mandatory. The endpoint must return current balance
The element “referencedate” in current balance is changed to “datetime”. The data type of the element is changed to date time
The availability information is removed from forward available balance
The response code 404 is removed as it is not applicable for collection endpoint
New endpoint statement-lines added
New endpoint statements added

Contact Support: Name: Standards & Developer Hub Email: developer-support@swift.com

FAQs
More
Claim this page
Report this page

ENDPOINTS

Instant Cash Reporting API

1. Setup - Refresh Token

2. getTransactionSummary - Retrieve transaction summary for an account.

3. getCashAccounts - Retrieve accounts and balances.

4. getStatementLines - Get statement entries with statement batch

5. getCashAccount - [SC Acc 2]: Retrieve balances for an account. Copy

6. Teardown - Revoke Token

7. getAccountStatement - Get statement with transaction.