v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Reports

List all Reconciliation Reports

Retrieve a paginated list of available reconciliation reports, querying by Company-Id, Mid, date range, and specific fields.

get/reports/reconciliations

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

filterstring

Filter the parameters that you want to return within the response.

start_datestring date
Example:2024-01-01

The start date and time for filtering results.

end_datestring date
Example:2024-01-31

The end date and time for filtering results.

bank'trust_payments' | 'cashflows' | 'shift4' | 'acquired'
Example:trust_payments

Specifies which banks to return reports for.

type'card' | 'account_to_account'
Example:card

Specifies the report source.

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Response

OK

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "id": "95be5f8a-5896-4dbd-a84c-96767701815f-YYYYMMDD",
      "date": "2023-08-01",
      "mid": "e6c1e2d3-2a36-4ad1-9f3c-22f64a49f876",
      "total": 100,
      "link": "/reports/reconciliations/95be5f8a-5896-4dbd-a84c-96767701815f-YYYYMMDD-a2a",
      "type": "account_to_account",
      "bank": "acquired"
    }
  ]
}