Sign in

v66

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

Get network total

Retrieve a specific network total record by token. Not available in sandbox.

get/v1/reports/settlement/network_totals/{token}

Path parameters

tokenstring uuid required

Token of the network total record to retrieve

Response

OK

tokenstring uuid required

Globally unique identifier.

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

Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO, or INTERLINK.

institution_idstring required

The institution that activity occurred on. For Mastercard: ICA (Interbank Card Association). For Maestro: institution ID. For Visa: lowest level SRE (Settlement Reporting Entity).

settlement_institution_idstring required

The institution responsible for settlement. For Mastercard: same as institution_id. For Maestro: billing ICA. For Visa: Funds Transfer SRE (FTSRE).

settlement_servicestring required

Settlement service.

report_datestring date required

Date that the network total record applies to. YYYY-MM-DD format.

cycleinteger

The clearing cycle that the network total record applies to. Mastercard only.

currencystring required

3-character alphabetic ISO 4217 code.

is_completeboolean required

Indicates that all settlement records related to this Network Total are available in the details endpoint.

createdstring date-time required

RFC 3339 timestamp for when the record was created. UTC time zone.

updatedstring date-time required

RFC 3339 timestamp for when the record was last updated. UTC time zone.

Example response

{
  "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"
}