v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB

Endpoints

List the daily funding summaries

Return a funding summary which contains a combined total of all fundings in the given date range, as well as daily summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID (as appropriate).

get/fundings/funding-summaries

Query parameters

fundedAfterstring date

Filter fundings on the funded field from the given date value in ISO 8601 format yyyy-MM-dd, anything from the time 00:00:00 on the given day would match.

Default: 30 days prior to the current day

fundedBeforestring date

Filter fundings on the funded field up to and including the given date value in ISO 8601 format yyyy-MM-dd, anything up the the time 23:59:59 on the given day would match.

Default: Current day

limitinteger

Number of elements to be returned in a single query.

Can be used for page/offset or cursor based pagination

offsetinteger

Starting point to start retrieving the elements from. It is "0" based i.e. value "0" signifies the first page.

This can be used with "limit".

Can be used for page/offset based pagination.

Headers

Partner-Codestring

Example:DIGI_PAYMENTS

For use by an alliance when there is a need to filter on a specific partner within their scope. May be restricted based on the API key.

Merchant-Idstring

Example:1234567890

For use by an alliance or partner when there is a need to filter on a specific merchant within their scope. May be restricted based on the API key.

Response

Example response

{
  "combined": {
    "merchant": {
      "id": "520334547514337",
      "allianceCode": "FISV",
      "partnerCode": "DIGI_PMNTS"
    },
    "amountTransacted": "1585.72",
    "amountFunded": "1500.30",
    "currencyCode": "GBP"
  },
  "daily": [
    {
      "day": "2022-02-15",
      "amountTransacted": "1585.72",
      "amountFunded": "1500.30",
      "_links": {
        "fundings": {
          "href": "/fundings?fundedAfter=2022-02-15&fundedBefore=2022-02-15"
        }
      }
    }
  ]
}