Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Connections

List connection reports

Retrieve all connection reports.

get/connectivity/v2beta/connections/{cid}/reports

Path parameters

cidstring required

Atlar connection ID.

Query parameters

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

type'STATEMENT' | 'INVESTMENT' | 'ACCOUNTING' | 'FX_RATES' | 'PAYMENT_STATUS' | 'BENCHMARK_RATES'

The type of the report.

The report type to filter for.

statementType'BOOKED' | 'PENDING'

The statement type to filter for. Only applicable if type is STATEMENT.

Response

List of connection reports.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "connectionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "content": {
        "contentType": "application/vnd.iso20022.camt.053.001.02+xml",
        "size": 4711,
        "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
        "name": "camt053_20240105.xml"
      },
      "version": 1,
      "etag": "version:3",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}