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:57 UTC.
62 endpoints are in reach of the transactions:read 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.
Payments
Campaigns
Group payment links into a campaign with one status, one schedule and one report.
- GET
/api/campaignsdeprecated transactions:read Get a list of Campaigns Requires: Campaigns.Campaigns, merchant scope. - POST
/api/campaigns/list/continuationdeprecated transactions:read Retrieves a continuation-based page of Campaigns. Requires: Campaigns.Campaigns, merchant scope. - POST
/api/campaigns/list/continuation/countdeprecated transactions:read Counts the Campaigns that match a filter. Requires: Campaigns.Campaigns, merchant scope. - POST
/api/campaigns/list/continuation/summary-countsdeprecated transactions:read Counts Campaigns for several filters at once. Requires: Campaigns.Campaigns, merchant scope. - GET
/api/campaigns/{id}deprecated transactions:read Get a Campaign Requires: Campaigns.Campaigns, merchant scope. - GET
/api/campaigns/{id}/accessdeprecated transactions:read Check Campaign access Requires: Campaigns.Campaigns, merchant scope. - GET
/api/campaigns/{id}/namedeprecated transactions:read Get a Campaign name by id Requires: Campaigns.Campaigns, merchant scope. - GET
/api/campaigns/{id}/progressdeprecated transactions:read Reads a campaign's public progress. No permission required.
Payments
Hosted Payment Pages
Hosted payment pages: the checkout pages WinkPG hosts on a merchant's behalf, their branding and field configuration, and the sessions a shopper is sent to.
- GET
/api/hostedpaymentpagesdeprecated transactions:read List hosted payment pages Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/list/continuationdeprecated transactions:read Retrieves a continuation-based page of HostedPaymentPages. Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/list/continuation/countdeprecated transactions:read Counts the HostedPaymentPages that match a filter. Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/list/continuation/summary-countsdeprecated transactions:read Counts HostedPaymentPages for several filters at once. Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - GET
/api/hostedpaymentpages/sessionsdeprecated transactions:read Lists HPP sessions for a specific hosted payment page. Requires: HostedPaymentPage.HppSessions, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/clone-datadeprecated transactions:read Retrieves the full prefilled field data for an existing session for cloning. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/completionsdeprecated transactions:read Lists the completions of one reusable payment link: one row per payer who arrived on it. Requires: HostedPaymentPage.HppSessions, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/level3-datadeprecated transactions:read Returns the Level 3 commercial-card payload stored on a session. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/payment-linkdeprecated transactions:read Returns the canonical payment-link URL for a session. Requires: HostedPaymentPage.HppSessions, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/qrcode.pngdeprecated transactions:read Serves a QR code PNG image for the session's payment link. Requires: HostedPaymentPage.HppSessions, merchant scope. - GET
/api/hostedpaymentpages/{id}deprecated transactions:read Get hosted payment page Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - GET
/api/hostedpaymentpages/{id}/accessdeprecated transactions:read Check page access Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - GET
/api/hostedpaymentpages/{id}/namedeprecated transactions:read Get page name Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - GET
/sdk/core/manifest.jsondeprecated transactions:read Publishes the release this host serves. No permission required. - GET
/sdk/core/{version}/{fingerprint}/{file}deprecated transactions:read Serves one published artifact. No permission required. - GET
/sdk/sample/{product}.zipdeprecated transactions:read Serves the sample for the given SDK product, preconfigured for this environment and brand. No permission required. - GET
/sdk/v1/{product}.jsdeprecated transactions:read Serves the shim for the given SDK product. No permission required.
Payments
Promotions
Merchant promotion codes: one discount, one validity window and one set of redemption ceilings, shared by hosted pages, contracts and invoices.
- GET
/api/promotionsdeprecated transactions:read Get a list of Promotions Requires: Promotions.Promotions, merchant scope. - POST
/api/promotions/list/continuationdeprecated transactions:read Retrieves a continuation-based page of Promotions. Requires: Promotions.Promotions, merchant scope. - POST
/api/promotions/list/continuation/countdeprecated transactions:read Counts the Promotions that match a filter. Requires: Promotions.Promotions, merchant scope. - POST
/api/promotions/list/continuation/summary-countsdeprecated transactions:read Counts Promotions for several filters at once. Requires: Promotions.Promotions, merchant scope. - GET
/api/promotions/{id}deprecated transactions:read Get a Promotion Requires: Promotions.Promotions, merchant scope. - GET
/api/promotions/{id}/accessdeprecated transactions:read Check Promotion access Requires: Promotions.Promotions, merchant scope. - GET
/api/promotions/{id}/namedeprecated transactions:read Get a Promotion name by id Requires: Promotions.Promotions, merchant scope.
Payments
Shipping
A merchant's ship-from origins and parcel presets: the two inputs a shipping rate quote needs beyond the destination.
- GET
/api/shipping/parcel-presetsdeprecated transactions:read Parcel presets: retrieves a paged list of presets. Requires: Shipping.ParcelPresets, merchant scope. - GET
/api/shipping/parcel-presets/continuationdeprecated transactions:read Parcel presets: retrieves a continuation-token paged list of presets. Requires: Shipping.ParcelPresets, merchant scope. - GET
/api/shipping/parcel-presets/continuation/countdeprecated transactions:read Parcel presets: counts the presets matching the input. Requires: Shipping.ParcelPresets, merchant scope. - GET
/api/shipping/parcel-presets/{id}deprecated transactions:read Parcel presets: retrieves a single preset by id. Requires: Shipping.ParcelPresets, merchant scope. - GET
/api/shipping/parcel-presets/{id}/accessdeprecated transactions:read Parcel presets: reports whether the caller may access the preset. Requires: Shipping.ParcelPresets, merchant scope. - GET
/api/shipping/parcel-presets/{id}/namedeprecated transactions:read Parcel presets: returns a preset's display name. Requires: Shipping.ParcelPresets, merchant scope. - GET
/api/shipping/originsdeprecated transactions:read Ship-from origins: retrieves a paged list of origins. Requires: Shipping.Origins, merchant scope. - GET
/api/shipping/origins/continuationdeprecated transactions:read Ship-from origins: retrieves a continuation-token paged list of origins. Requires: Shipping.Origins, merchant scope. - GET
/api/shipping/origins/continuation/countdeprecated transactions:read Ship-from origins: counts the origins matching the input. Requires: Shipping.Origins, merchant scope. - GET
/api/shipping/origins/{id}deprecated transactions:read Ship-from origins: retrieves a single origin by id. Requires: Shipping.Origins, merchant scope. - GET
/api/shipping/origins/{id}/accessdeprecated transactions:read Ship-from origins: reports whether the caller may access the origin. Requires: Shipping.Origins, merchant scope. - GET
/api/shipping/origins/{id}/namedeprecated transactions:read Ship-from origins: returns an origin's display name. Requires: Shipping.Origins, merchant scope. - POST
/api/shipping/rate-quotesdeprecated transactions:read Shipping rate quotes: quotes carrier rates for one lane. Requires: Shipping.RateQuotes, merchant scope.
Payments
Transactions
Payment transaction processing, search, settlement, and reporting.
- GET
/api/transactionsdeprecated transactions:read List transactions Requires: Transactions.Reports, merchant scope. - POST
/api/transactions/get-by-idempotency-key-asyncdeprecated transactions:read Looks up a transaction by the idempotency key the caller supplied. Requires: Transactions.Reports.View, merchant scope. - POST
/api/transactions/get-transaction-by-id-asyncdeprecated transactions:read Retrieves a single transaction by its identifier. Requires: Transactions.Reports, merchant scope. - POST
/api/transactions/get-unsettled-transaction-summary-by-processor-profile-asyncdeprecated transactions:read Summarizes the unsettled transactions on a merchant's processor profile. Requires: Transactions.Reports, merchant scope. - POST
/api/transactions/list/continuationdeprecated transactions:read Retrieves a continuation-based page of Transactions. Requires: Transactions.Reports, merchant scope. - POST
/api/transactions/list/continuation/countdeprecated transactions:read Counts the Transactions that match a filter. No permission required. - POST
/api/transactions/list/continuation/summary-countsdeprecated transactions:read Counts Transactions for several filters at once. Requires: Transactions.Reports, merchant scope. - POST
/api/transactions/virtual-terminal/recentdeprecated transactions:read Lists your recent Virtual Terminal transactions. Requires: Transactions.VirtualTerminal, merchant scope. - GET
/api/transactions/{id}deprecated transactions:read Get transaction by ID Requires: Transactions.Reports, merchant scope. - GET
/api/transactions/batch-filedeprecated transactions:read Gets a filtered, paged list of batch files. Requires: Transactions.BatchFiles, merchant scope. - GET
/api/transactions/batch-file/{id}deprecated transactions:read Gets a batch file by its unique identifier. Requires: Transactions.BatchFiles, merchant scope. - GET
/api/transactions/batch-file/{id}/downloaddeprecated transactions:read Downloads the batch file's lines as CSV, with card numbers masked. Requires: Transactions.BatchFiles.Download, merchant scope. - GET
/api/transactions/batch-file/{id}/export-resultsdeprecated transactions:read Exports batch processing results as a CSV file. Requires: Transactions.BatchFiles.Download, merchant scope. - GET
/api/transactions/reports/merchant-summarydeprecated transactions:read Rolls up the window's transactions by merchant. Requires: Transactions.Reports.Summary, merchant scope. - GET
/api/transactions/reports/paytype-summarydeprecated transactions:read Rolls up the window's transactions by payment type. Requires: Transactions.Reports.Summary, merchant scope. - GET
/api/transactions/{id}/split-tenderdeprecated transactions:read Get the split tender a payment belongs to. Requires: Transactions.Reports, merchant scope.
Payments
Transaction Statistics
The filtered transaction-statistics aggregate: count and total amount over every transaction matching a filter, grouped by transaction type, by payment type and by result code.