Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
Settlement Report

List network totals

List network total records with optional filters. Not available in sandbox.

get/v1/reports/settlement/network_totals

Query parameters

report_datestring date

Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjunction with report_date_begin or report_date_end.

report_date_beginstring date

Earliest report date to filter on, inclusive (YYYY-MM-DD).

report_date_endstring date

Latest report date to filter on, inclusive (YYYY-MM-DD).

network'AMEX' | 'VISA' | 'MASTERCARD' | 'MAESTRO' | 'INTERLINK'

Network to filter on.

institution_idstring

Institution ID to filter on.

settlement_institution_idstring

Settlement institution ID to filter on.

beginstring date-time

Datetime in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

endstring date-time

Datetime in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

page_sizeinteger

Number of records per page.

starting_afterstring uuid

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

ending_beforestring uuid

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

Response

OK

has_moreboolean required

Indicates whether there are more network total records to be retrieved.

Example response

{
  "data": [
    {
      "token": "12cf7505-06a8-435e-b1c7-4c430d02f6c3",
      "network": "VISA",
      "institution_id": "1000000000",
      "settlement_institution_id": "1000000001",
      "settlement_service": "015",
      "report_date": "2025-02-25",
      "currency": "CAD",
      "is_complete": true,
      "amounts": {
        "gross_settlement": 100,
        "interchange_fees": -25,
        "visa_charges": 10,
        "net_settlement": 85
      },
      "created": "2025-02-25T13:07:31.419631Z",
      "updated": "2025-02-25T13:07:31.419631Z"
    },
    {
      "token": "0604c316-17f0-456d-9ac7-7d94252acb1a",
      "network": "INTERLINK",
      "institution_id": "1000000000",
      "settlement_institution_id": "1000000001",
      "settlement_service": "001",
      "report_date": "2025-02-25",
      "currency": "USD",
      "is_complete": true,
      "amounts": {
        "gross_settlement": 200,
        "interchange_fees": -50,
        "visa_charges": 10,
        "net_settlement": 160
      },
      "created": "2025-02-25T13:07:31.419631Z",
      "updated": "2025-02-25T13:07:31.419631Z"
    },
    {
      "token": "700a1c78-04ed-47e2-8160-b1e18914ec7b",
      "network": "MASTERCARD",
      "institution_id": "031511",
      "settlement_institution_id": "031511",
      "settlement_service": "US00000001",
      "report_date": "2025-02-25",
      "currency": "USD",
      "cycle": 1,
      "is_complete": false,
      "amounts": {
        "gross_settlement": 100,
        "interchange_fees": -25,
        "net_settlement": 75
      },
      "created": "2025-02-25T13:07:31.419631Z",
      "updated": "2025-02-25T13:07:31.419631Z"
    },
    {
      "token": "e05d5448-210e-4cc3-bd0d-d54d3c6c9a9f",
      "network": "MASTERCARD",
      "institution_id": "031511",
      "settlement_institution_id": "031511",
      "settlement_service": "US00000001",
      "report_date": "2025-02-25",
      "currency": "USD",
      "cycle": 2,
      "is_complete": true,
      "amounts": {
        "gross_settlement": 100,
        "interchange_fees": -25,
        "net_settlement": 75
      },
      "created": "2025-02-25T13:07:31.419631Z",
      "updated": "2025-02-25T13:07:31.419631Z"
    }
  ],
  "has_more": false
}