Connections

List connection reports

Changed on

Retrieve all connection reports.

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

Request

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.

fromstring date-time

Filter reports created at or after this timestamp.

tostring date-time

Filter reports created at or before this timestamp.

type'STATEMENT' | 'INVESTMENT' | 'ACCOUNTING' | 'FX_RATES' | 'PAYMENT_STATUS' | 'BENCHMARK_RATES' | 'INSTRUMENT_PRODUCTS' | 'ACCOUNTS' | 'OTHER'

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"
      },
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "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
}

Changes

    • breaking

      added to the /// response property oneOf list for the response status

    • warning

      added the new application/pdf enum value to the //// response property for the response status

    • warning

      added the new application/vnd.adyen.balance-platform.statement-report+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.atlar.connectivity.v2.instrument-product-statement+json enum value to the //// response property for the response status

    • warning

      added the new application/vnd.blackrock.cachematrix.balance+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.blackrock.cachematrix.transactions+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.deutsche.wealth-online+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.ebics.hac.v25+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.ebics.hac.v30+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.ebics.htd.v30+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.edi.997 enum value to the //// response property for the response status

    • warning

      added the new application/vnd.iso20022.camt.053.001.12+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.iso20022.pacs.002.001.10+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.iso20022.pain.008.001.08+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.jpm.daily-feed+zip enum value to the //// response property for the response status

    • warning

      added the new application/vnd.jpm.morgan-money.balance-report+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.jpm.morgan-money.transaction-report+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.jpm.soci.cash-balance+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.jpm.soci.holdings+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.jpm.soci.transactions+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.m2.m006.m001+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.m2.m006.m005+xml enum value to the //// response property for the response status

    • warning

      added the new application/vnd.nordea.investments.abasec.pos+csv enum value to the //// response property for the response status

    • warning

      added the new application/vnd.nordea.investments.abasec.tra+csv enum value to the //// response property for the response status

    • warning

      added the new application/zip enum value to the //// response property for the response status

    • warning

      added the new text/csv enum value to the //// response property for the response status

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter to

    • info

      added the new enum value ACCOUNTS to the query request parameter type

    • info

      added the new enum value INSTRUMENT_PRODUCTS to the query request parameter type

    • info

      added the new enum value OTHER to the query request parameter type

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added STATEMENT discriminator mapping keys to the /// response property for the response status

    • info

      added the required property /// to the response with the status