Get paginated merchant ledger entries.

GET /api/usage/reports/merchant-ledger deprecated

Requires: Usage.Reports, merchant scope.

Returns a continuation token in the response body for paging beyond the first page.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/usage/reports/merchant-ledger?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/usage/reports/merchant-ledger?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, UsageApi } from '@winkpg/winkpg-api';

const api = new UsageApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.usageReportingGetMerchantLedger("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/usage/reports/merchant-ledger?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new UsageApi(config);
var result = await api.UsageReportingGetMerchantLedgerAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/usage/reports/merchant-ledger?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.UsageApi(client)
    result = api.usage_reporting_get_merchant_ledger("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/usage/reports/merchant-ledger?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`MerchantId` required	query	string (uuid)	The merchant ID.
`ResellerId` required	query	string (uuid)	The reseller ID the merchant belongs to.
`SkuCode` required	query	string	Optional SKU code filter.
`Period` required	query	string	Period key (e.g., "202602"). Defaults to current period if null.
`MaxResultCount` required	query	integer (int32)	Maximum number of results to return.
`ContinuationToken` required	query	string	Continuation token from a previous page response. Null for the first page.
`IncludeDeleted` required	query	boolean	Not used by this read-only endpoint: soft-deleted ledger entries are not surfaced.
`IncludeInactive` required	query	boolean	Not used by this read-only endpoint.
`IncludeApproxTotalCount` required	query	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.