API reference
WinkPG API version v1. 683 endpoints published by this instance.
The API reference isn't available right now
This instance couldn't load its API specification, so this page lists nothing. The reference returns as soon as the specification is readable again.
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
19 endpoints are in reach of the reports scope. Scopes only restrict a key, so the account that owns it still needs the permissions each endpoint lists.
This instance publishes no API operations.
No endpoint this instance publishes is in reach of that scope. Choose All scopes to see the whole reference.
Billing & Invoicing
Recurring Billing
Recurring billing for customer contracts: triggering a run by hand, and the history of runs already executed.
- GET
/api/customers/recurring-billing/contracts/{contractId}/historydeprecated reports Get billing history filtered by contract. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - GET
/api/customers/recurring-billing/customers/{customerId}/historydeprecated reports Get billing history filtered by customer. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - GET
/api/customers/recurring-billing/historydeprecated reports Get paginated execution history of recurring billing runs. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - GET
/api/customers/recurring-billing/runs/{id}deprecated reports Get the detail of a specific billing run, including per-contract items. Requires: Customers.RecurringBilling.ViewHistory, merchant scope.
Reporting & Operations
Reports
Report generation, scheduling, and export.
- GET
/api/reportsdeprecated reports Lists the reports you can run. No permission required. - GET
/api/reports/{reportId}/columnsdeprecated reports Lists the columns a report returns. No permission required. - POST
/api/reports/{reportId}/exportdeprecated reports Runs a report and returns it as a file. No permission required. - GET
/api/reports/{reportId}/parametersdeprecated reports Lists the filters a report accepts. No permission required. - POST
/api/reports/{reportId}/rundeprecated reports Runs a report and returns its rows. No permission required.
Payments
Transactions
Payment transaction processing, search, settlement, and reporting.
- GET
/api/transactions/settlement-reports/batches/{settlementBatchId}deprecated reports Returns the full detail of one settlement batch, including the per-payment-type breakdown. Requires: Transactions.Settlement.ViewHistory, merchant scope. - GET
/api/transactions/settlement-reports/historydeprecated reports Returns a page of settlement batches matching the supplied filters, newest run first. Requires: Transactions.Settlement.ViewHistory, merchant scope.
Reporting & Operations
Usage
Metered usage reporting: period summaries, the underlying ledger entries, and the SKU definitions they are metered against.
- GET
/api/usage/reports/dimensional-summarydeprecated reports Get a paged dimensional rollup for a SKU. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/merchant-ledgerdeprecated reports Get paginated merchant ledger entries. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/merchant-summarydeprecated reports Get a merchant's usage summary for a given period. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/reseller-merchant-breakdowndeprecated reports Get per-merchant usage breakdown for a reseller. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/reseller-summarydeprecated reports Get a reseller's aggregated usage summary across all their merchants. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/skusdeprecated reports List all registered SKU definitions. Requires: Usage.Skus, merchant scope. - GET
/api/usage/reports/ledger/exportdeprecated reports Export merchant ledger entries. Requires: Usage.Reports.Export, merchant scope. - GET
/api/usage/reports/summary/exportdeprecated reports Export the merchant SKU summary. Requires: Usage.Reports.Export, merchant scope.