List hosted payment pages

GET /api/hostedpaymentpages deprecated

Requires: HostedPaymentPage.HostedPaymentPages, merchant scope.

Retrieves a paginated list of hosted payment pages with optional filtering.

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/hostedpaymentpages" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/hostedpaymentpages' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.hostedPaymentPagesGetList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages', {
  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 HostedPaymentPagesApi(config);
var result = await api.HostedPaymentPagesGetListAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/hostedpaymentpages");
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.HostedPaymentPagesApi(client)
    result = api.hosted_payment_pages_get_list()

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/hostedpaymentpages",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`MaxCreationTime` required	query	string (date-time)
`MinCreationTime` required	query	string (date-time)
`MaxModificationTime` required	query	string (date-time)
`MaxModifitionTime` required	query	string (date-time)	Deprecated misspelled alias of `maxModificationTime`. Deprecated misspelling kept for compatibility. Use MinModificationTime or MaxModificationTime instead. When a request sends both spellings of the same bound, the correctly spelled parameter is used and this one is ignored.
`MinModificationTime` required	query	string (date-time)
`MinModifitionTime` required	query	string (date-time)	Deprecated misspelled alias of `minModificationTime`. Deprecated misspelling kept for compatibility. Use MinModificationTime or MaxModificationTime instead. When a request sends both spellings of the same bound, the correctly spelled parameter is used and this one is ignored.
`PagePurpose` required	query	HppPagePurpose	Optional server-side filter on the page's effective `HppPagePurpose`. When set, only pages whose resolved purpose (null resolves to `Payment`) equals this value are returned. Used by purpose-scoped candidate lookups (e.g. the reseller billing-preferences card-capture HPP picker, which must only ever surface `SaveCard` pages) so a caller cannot retrieve a non-matching page through that path. `null` leaves the result unfiltered by purpose.
`MerchantId` required	query	string (uuid)	Optional server-side filter on the owning merchant. When set, only pages whose `MerchantId` equals this value are returned, and the total count reflects that same filtered set. A merchant-scoped request is cheaper and faster than an unscoped one. This narrows within the caller's existing access scope and never widens it: a merchant the caller cannot see yields an empty result rather than a leak. `null` leaves the result unfiltered by merchant. Mirrors `GetHostedPaymentPageContinuationInput.MerchantId` on the continuation list path.
`Filter` required	query	string	Gets or sets a general filter string for the result set.
`Name` required	query	string	Gets or sets the name filter for the result set.
`IncludeDeleted` required	query	boolean	Gets or sets a value indicating whether to include deleted entities in the result set.
`IncludeInactive` required	query	boolean	Gets or sets a value indicating whether to include inactive entities in the result set.
`Ids` required	query	array of string (uuid)	Gets or sets a list of entity IDs to filter the result set.
`Sorting` required	query	string
`SkipCount` required	query	integer (int32)
`MaxResultCount` required	query	integer (int32)
`ExtraProperties` required	query	object
`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.