# POST /api/tokens/list/continuation

Retrieves a continuation-based page of PaymentTokens.

This endpoint uses continuation tokens instead of skip/take paging.

**Operation ID:** `tokensGetContinuationList`

## Authorization

No permission required.

Requires API key scope: `tokens`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: [`GetPaymentTokensContinuationInput`](https://devportal.demo.winkpg.io/docs/api/models/GetPaymentTokensContinuationInput.md)

Properties:
- `merchantId` (string(uuid)): The merchant identifier whose tokens will be retrieved. (nullable)
- `filter` ([FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md))
  Fields:
  - `logic` ([FilterLogic](https://devportal.demo.winkpg.io/docs/api/models/FilterLogic.md))
    Values:
    - `And`
    - `Or`
  - `rules` (array<[FilterRule](https://devportal.demo.winkpg.io/docs/api/models/FilterRule.md)>): (nullable)
  - `groups` (array<[FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable)
- `maxResultCount` (integer(int32)): The maximum number of items to return in a single page.
- `continuationToken` (string): (nullable)
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (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. (nullable)
- `sorting` ([SortDescriptor](https://devportal.demo.winkpg.io/docs/api/models/SortDescriptor.md))
  Fields:
  - `field` (string): (nullable)
  - `descending` (boolean)

**Content type:** `text/json`

Schema: [`GetPaymentTokensContinuationInput`](https://devportal.demo.winkpg.io/docs/api/models/GetPaymentTokensContinuationInput.md)

Properties:
- `merchantId` (string(uuid)): The merchant identifier whose tokens will be retrieved. (nullable)
- `filter` ([FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md))
  Fields:
  - `logic` ([FilterLogic](https://devportal.demo.winkpg.io/docs/api/models/FilterLogic.md))
    Values:
    - `And`
    - `Or`
  - `rules` (array<[FilterRule](https://devportal.demo.winkpg.io/docs/api/models/FilterRule.md)>): (nullable)
  - `groups` (array<[FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable)
- `maxResultCount` (integer(int32)): The maximum number of items to return in a single page.
- `continuationToken` (string): (nullable)
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (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. (nullable)
- `sorting` ([SortDescriptor](https://devportal.demo.winkpg.io/docs/api/models/SortDescriptor.md))
  Fields:
  - `field` (string): (nullable)
  - `descending` (boolean)

**Content type:** `application/*+json`

Schema: [`GetPaymentTokensContinuationInput`](https://devportal.demo.winkpg.io/docs/api/models/GetPaymentTokensContinuationInput.md)

Properties:
- `merchantId` (string(uuid)): The merchant identifier whose tokens will be retrieved. (nullable)
- `filter` ([FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md))
  Fields:
  - `logic` ([FilterLogic](https://devportal.demo.winkpg.io/docs/api/models/FilterLogic.md))
    Values:
    - `And`
    - `Or`
  - `rules` (array<[FilterRule](https://devportal.demo.winkpg.io/docs/api/models/FilterRule.md)>): (nullable)
  - `groups` (array<[FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable)
- `maxResultCount` (integer(int32)): The maximum number of items to return in a single page.
- `continuationToken` (string): (nullable)
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (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. (nullable)
- `sorting` ([SortDescriptor](https://devportal.demo.winkpg.io/docs/api/models/SortDescriptor.md))
  Fields:
  - `field` (string): (nullable)
  - `descending` (boolean)

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`ContinuationPagedResultDtoOfPaymentTokenDto`](https://devportal.demo.winkpg.io/docs/api/models/ContinuationPagedResultDtoOfPaymentTokenDto.md)

Properties:
- `items` (array<[PaymentTokenDto](https://devportal.demo.winkpg.io/docs/api/models/PaymentTokenDto.md)>): The items returned for this page. (nullable)
  Fields of each item:
  - `extraProperties` (object): (nullable, read only)
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `tenantId` (string(uuid)): Id of the related tenant. (nullable, read only)
  - `concurrencyStamp` (string): (nullable)
  - `numericToken` (integer(int64)): The numeric representation of the token. (nullable)
  - `cardFormatToken` (string): The card format representation of the token. (nullable)
  - `transactionId` (string(uuid)): The unique identifier of the associated transaction when the token was created. (nullable)
  - `paymentDetails` ([PaymentDetailSnapshot](https://devportal.demo.winkpg.io/docs/api/models/PaymentDetailSnapshot.md)): The payment details snapshot associated with this token.
  - `type` ([TokenType](https://devportal.demo.winkpg.io/docs/api/models/TokenType.md)): The underlying payment type of the token.
    Values:
    - `Card`: A card, keyed or read.
    - `Check`: A bank account debited over ACH, or a check.
    - `Cash`: Cash, which carries no instrument block of its own.
    - `DigitalWallet`: A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks.
    - `AlternativePayment`: An alternative payment method approved inside a provider (PayPal, Venmo, Pay Later, Affirm, Klarna, Afterpay) and presented to the gateway as an approval reference.
  - `category` ([TokenCategory](https://devportal.demo.winkpg.io/docs/api/models/TokenCategory.md)): The category of the token (e.g., internal, network).
    Values:
    - `Internal`
    - `Network`
    - `Wallet`
  - `merchantId` (string(uuid)): Id of the related Merchant. (nullable)
  - `customerId` (string(uuid)): The customer this stored credential is bound to, or `null` when it is not bound to one. (nullable)
  - `tokenSharing` (boolean): The sharing status of the token.
  - `label` (string): Optional human-readable label for the token. (nullable)
  - `status` ([TokenStatus](https://devportal.demo.winkpg.io/docs/api/models/TokenStatus.md)): The status of the token (Active, Inactive, Invalidated).
    Values:
    - `Active`: Token is active and can be used for transactions.
    - `Inactive`: Token is inactive but can be reactivated.
    - `Invalidated`: Token has been invalidated and replaced by a new token. Cannot be used for new transactions and cannot be reactivated.
    - `Redacted`: The vaulted account data has been wiped at the owner's request, leaving an audit shell: the last four, brand, BIN metadata, expiry, customer, merchant and lifecycle history survive, and the card number, cardholder name, bank account / routing / MICR values and any stored processor or network token do not.
  - `invalidatedByTokenId` (string(uuid)): The ID of the token that replaced this one (if invalidated and regenerated). (nullable)
  - `replacesTokenId` (string(uuid)): The ID of the token that this token replaced (if this is a regenerated token). (nullable)
  - `regenerationReason` ([TokenRegenerationReason](https://devportal.demo.winkpg.io/docs/api/models/TokenRegenerationReason.md)): The reason for token regeneration (if applicable). (nullable)
    Values:
    - `Manual`: Manually initiated by user.
    - `NearExpiration`: Automated regeneration due to near expiration.
    - `SuspectedCompromise`: Suspected compromise or security concern.
    - `Other`: Other reason.
  - `lastRegeneratedAt` (string(date-time)): The timestamp when this token was last regenerated. (nullable)
  - `redactedAt` (string(date-time)): When the token's stored card or bank account details were erased, or `null` for a token  that has not been redacted. (nullable)
  - `redactionReason` (string): The reason recorded when the token's stored details were erased, or `null` for a token  that has not been redacted. (nullable)
  - `publicReference` (string): The stable, opaque `pt_`-prefixed handle for this token: the only token identifier  permitted to leave the gateway, and the value to charge against on a merchant-initiated  transaction. Distinct from the internal id, which correlates to a card number and is never  treated as a merchant-facing handle. (nullable)
- `nextContinuationToken` (string): Continuation token to use when requesting the next page.  Null means no additional pages exist. (nullable)
- `approxTotalCount` (integer(int64)): An approximate total count of matching items.  This value is optional and may be stale or estimated, so treat it as an approximation. (nullable)
- `pageItemCount` (integer(int32)): Convenience property for the number of items in this page. (read only)
- `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior.

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## 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 GetPaymentTokensContinuationInput. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/tokens/list/continuation" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {
    "field": "",
    "descending": false
  }
}'
```

### PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {
    "field": "",
    "descending": false
  }
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/tokens/list/continuation' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, TokensApi } from '@winkpg/winkpg-api';

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

const { data } = await api.tokensGetContinuationList({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {
    "field": "",
    "descending": false
  }
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/tokens/list/continuation', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "filter": {
      "logic": "And",
      "rules": [],
      "groups": []
    },
    "maxResultCount": 0,
    "continuationToken": "",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false,
    "sorting": {
      "field": "",
      "descending": false
    }
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

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

var api = new TokensApi(config);
var body = JsonSerializer.Deserialize<GetPaymentTokensContinuationInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      },
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {
        "field": "",
        "descending": false
      }
    }
    """);

var result = await api.TokensGetContinuationListAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/tokens/list/continuation");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      },
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {
        "field": "",
        "descending": false
      }
    }
    """, Encoding.UTF8, "application/json");

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

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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.TokensApi(client)
    body = winkpg_api.GetPaymentTokensContinuationInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      },
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False,
      "sorting": {
        "field": "",
        "descending": False
      }
    })
    result = api.tokens_get_continuation_list(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False,
  "sorting": {
    "field": "",
    "descending": False
  }
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/tokens/list/continuation",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.