# POST /api/contracts/list/continuation Retrieves a continuation-based page of Contracts. This endpoint uses continuation tokens instead of skip/take paging. **Operation ID:** `contractsGetContinuationList` ## Authorization Requires: Customers.Contracts, merchant scope. Requires API key scope: `admin` Required permissions: - `Customers.Contracts` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: [`GetContractContinuationInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/GetContractContinuationInput.md) Properties: - `customerId` (string(uuid)): Gets or sets an optional customer identifier to filter contracts by owner. (nullable) - `filter` ([FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)): Gets or sets the filter group containing advanced filter expressions. Fields: - `logic` ([FilterLogic](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterLogic.md)) Values: - `And` - `Or` - `rules` (array<[FilterRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterRule.md)>): (nullable) - `groups` (array<[FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable) - `maxResultCount` (integer(int32)): Gets or sets the maximum number of results to return per page. - `continuationToken` (string): Gets or sets the continuation token from a previous query for retrieving the next page. (nullable) - `sorting` ([SortDescriptor](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SortDescriptor.md)): Gets or sets the sort descriptor controlling result ordering. Fields: - `field` (string): (nullable) - `descending` (boolean) - `maxCreationTime` (string(date-time)): Gets or sets the upper bound for filtering by creation time. (nullable) - `minCreationTime` (string(date-time)): Gets or sets the lower bound for filtering by creation time. (nullable) - `maxModificationTime` (string(date-time)): Gets or sets the upper bound for filtering by last modification time. (nullable) - `maxModifitionTime` (string(date-time)): Deprecated misspelled alias of `maxModificationTime`. (nullable, deprecated) - `minModificationTime` (string(date-time)): Gets or sets the lower bound for filtering by last modification time. (nullable) - `minModifitionTime` (string(date-time)): Deprecated misspelled alias of `minModificationTime`. (nullable, deprecated) - `includeDeleted` (boolean): Gets or sets a value indicating whether soft-deleted contracts should be included in results. - `includeInactive` (boolean): Gets or sets a value indicating whether inactive contracts should be included in results. - `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) **Content type:** `text/json` Schema: [`GetContractContinuationInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/GetContractContinuationInput.md) Properties: - `customerId` (string(uuid)): Gets or sets an optional customer identifier to filter contracts by owner. (nullable) - `filter` ([FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)): Gets or sets the filter group containing advanced filter expressions. Fields: - `logic` ([FilterLogic](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterLogic.md)) Values: - `And` - `Or` - `rules` (array<[FilterRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterRule.md)>): (nullable) - `groups` (array<[FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable) - `maxResultCount` (integer(int32)): Gets or sets the maximum number of results to return per page. - `continuationToken` (string): Gets or sets the continuation token from a previous query for retrieving the next page. (nullable) - `sorting` ([SortDescriptor](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SortDescriptor.md)): Gets or sets the sort descriptor controlling result ordering. Fields: - `field` (string): (nullable) - `descending` (boolean) - `maxCreationTime` (string(date-time)): Gets or sets the upper bound for filtering by creation time. (nullable) - `minCreationTime` (string(date-time)): Gets or sets the lower bound for filtering by creation time. (nullable) - `maxModificationTime` (string(date-time)): Gets or sets the upper bound for filtering by last modification time. (nullable) - `maxModifitionTime` (string(date-time)): Deprecated misspelled alias of `maxModificationTime`. (nullable, deprecated) - `minModificationTime` (string(date-time)): Gets or sets the lower bound for filtering by last modification time. (nullable) - `minModifitionTime` (string(date-time)): Deprecated misspelled alias of `minModificationTime`. (nullable, deprecated) - `includeDeleted` (boolean): Gets or sets a value indicating whether soft-deleted contracts should be included in results. - `includeInactive` (boolean): Gets or sets a value indicating whether inactive contracts should be included in results. - `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) **Content type:** `application/*+json` Schema: [`GetContractContinuationInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/GetContractContinuationInput.md) Properties: - `customerId` (string(uuid)): Gets or sets an optional customer identifier to filter contracts by owner. (nullable) - `filter` ([FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)): Gets or sets the filter group containing advanced filter expressions. Fields: - `logic` ([FilterLogic](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterLogic.md)) Values: - `And` - `Or` - `rules` (array<[FilterRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterRule.md)>): (nullable) - `groups` (array<[FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable) - `maxResultCount` (integer(int32)): Gets or sets the maximum number of results to return per page. - `continuationToken` (string): Gets or sets the continuation token from a previous query for retrieving the next page. (nullable) - `sorting` ([SortDescriptor](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SortDescriptor.md)): Gets or sets the sort descriptor controlling result ordering. Fields: - `field` (string): (nullable) - `descending` (boolean) - `maxCreationTime` (string(date-time)): Gets or sets the upper bound for filtering by creation time. (nullable) - `minCreationTime` (string(date-time)): Gets or sets the lower bound for filtering by creation time. (nullable) - `maxModificationTime` (string(date-time)): Gets or sets the upper bound for filtering by last modification time. (nullable) - `maxModifitionTime` (string(date-time)): Deprecated misspelled alias of `maxModificationTime`. (nullable, deprecated) - `minModificationTime` (string(date-time)): Gets or sets the lower bound for filtering by last modification time. (nullable) - `minModifitionTime` (string(date-time)): Deprecated misspelled alias of `minModificationTime`. (nullable, deprecated) - `includeDeleted` (boolean): Gets or sets a value indicating whether soft-deleted contracts should be included in results. - `includeInactive` (boolean): Gets or sets a value indicating whether inactive contracts should be included in results. - `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) ## Responses ### 200 OK **Content type:** `application/json` Schema: [`ContinuationPagedResultDtoOfContractDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContinuationPagedResultDtoOfContractDto.md) Properties: - `items` (array<[ContractDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractDto.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) - `customerId` (string(uuid)): Gets or sets the identifier of the customer who owns this contract. - `customerName` (string): Gets or sets the display name of the associated customer, used for grid rendering. (nullable) - `legacyNumber` (integer(int64)): Gets or sets the contract's legacy numeric key, the integer identifier the v1 API resolves contracts by. Server-owned: stamped at create and ignored on every inbound payload. Null on contracts created before the field existed and not yet back-filled by the v1 data migration. (nullable) - `totalExecutions` (integer(int32)): Gets or sets the total number of billing executions performed for this contract. - `successfulExecutions` (integer(int32)): Gets or sets the number of successful billing executions. - `failedExecutions` (integer(int32)): Gets or sets the number of failed billing executions. - `totalAmountBilled` (number(double)): Gets or sets the cumulative amount billed across all executions. - `amountPerAttempt` (number(double)): Gets or sets the amount charged per billing attempt. - `paymentMethodType` ([ContractPayMethodType](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractPayMethodType.md)): Gets or sets the type of payment method used by this contract. Values: - `Card` - `Check` - `customFields` (array<[ContractCustomField](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractCustomField.md)>): Gets or sets the merchant-defined custom field values carried on this contract, or null when it carries none. Null and an empty collection are different answers: null means the contract has never had custom fields set, empty means they were explicitly cleared. (nullable) - `perBillInvoice` ([ContractPerBillInvoice](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractPerBillInvoice.md)): Gets or sets the per-bill invoice configuration for this contract. - `thresholds` ([ContractThresholds](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractThresholds.md)): Gets or sets the threshold rules governing contract execution limits. - `aggregates` ([ContractAggregates](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractAggregates.md)): Gets or sets aggregate billing totals tracked across contract executions. - `schedule` ([ContractSchedule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractSchedule.md)): Gets or sets the recurrence schedule for contract execution. - `payMethod` ([ContractPayMethod](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractPayMethod.md)): Gets or sets the payment method configuration used when the contract is billed. - `emailNotifications` ([ContractEmailNotifications](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractEmailNotifications.md)): Gets or sets the email notification settings for contract billing events. - `isActive` (boolean): Gets or sets a value indicating whether this contract is active and eligible for execution. - `planId` (string(uuid)): Gets or sets the reusable plan this contract subscribes to for its price, or null when the contract carries its own inline amount. When set, the recurring billing engine resolves the amount from the plan at charge time and the per-bill amounts on this contract are a snapshot of it. (nullable) - `trialEndDate` (string(date-time)): Gets or sets the calendar day the contract's trial ends, in UTC, or null when the contract has no trial. While this day is still ahead the contract is active but not charged; the first charge falls on it, or on the schedule's first occurrence after it, at the full amount. (nullable) - `description` (string): Gets or sets an optional description providing additional context for the contract. (nullable) - `deactivationReason` ([ContractDeactivationReason](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractDeactivationReason.md)): Gets or sets the reason this contract was deactivated, or null when the contract is active or was never deactivated. Server-owned: set by the recurring billing engine when a threshold or schedule ends the contract, by the self-service cancellation flow when the payer cancels, and cleared back to null when the contract is reactivated. Read-only over the API; an inbound payload can never set it. (nullable, read only) Values: - `Suspended`: Suspended by the billing engine after consecutive failures exceeded the maxFailCount threshold. - `MaxPaymentsReached`: Total execution count (successful + failed) reached maxNumPayments. - `MaxSuccessfulBillsReached`: Successful execution count reached maxSuccessfulBills. - `MaxAmountReached`: Cumulative amount billed reached maxAmount. - `ScheduleExhausted`: The recurrence schedule produced no further occurrences: either the until end date was reached or the recurrence count was exhausted. - `Manual`: Manually deactivated by an operator via the UI or API. - `CancelledByCardholder`: Cancelled by the cardholder themselves, from the link in an upcoming-charge reminder, with no operator involved. - `Paused`: Paused on purpose by an operator, to be resumed later: either by hand, or automatically by the daily billing run once the contract's expected resume date has passed. A pause is a voluntary stop, which is what separates it from Suspended (the billing engine gave up after consecutive failures) and from Manual (deactivated with no intention to resume). The pause itself is described by the contract's pause fields (reason, paused date, expected resume date), which are cleared when the contract resumes. - `pauseReason` (string): Gets or sets why an operator paused this contract, or null when it is not paused. Present only while `deactivationReason` is `Paused`. Server-owned: written by the pause operation and cleared by every resume; read-only over the API. (nullable, read only) - `pausedDate` (string(date-time)): Gets or sets when the contract was paused, in UTC, or null when it is not paused. Server-owned and read-only over the API. (nullable, read only) - `expectedResumeDate` (string(date-time)): Gets or sets the UTC calendar day on which the daily billing run resumes the contract on its own, or null for a pause only an operator ends. Server-owned and read-only over the API; set it through the pause operation. (nullable, read only) - `convenienceFeeWaived` (boolean): Gets or sets whether the cardholder enrolled in this contract on terms that disclosed no convenience fee, so no scheduled charge under it carries one. Null or false means each charge's fee follows the merchant's convenience-fee configuration. Server-owned: recorded when the contract is created from a hosted payment page that carried no fee, and read-only over the API. (nullable, read only) - `dualPricingConsentedRate` (number(double)): Gets or sets the card price rate, as a decimal fraction, that the cardholder's consent stated when they enrolled, for a merchant that posts a cash price and a card price as a percentage. A card is charged the card price under this contract only when this or `dualPricingConsentedAmount` is set, and never uplifted by more than the consent stated. Null when the consent stated no card price, or stated it as an amount. Server-owned: recorded when the contract is created, from the consent the card's recurring charges run under (a hosted payment page enrollment, a consent recorded in the back office with the card price, or an API consent sent with `enrollmentTerms.cardPriceDisclosed`), and read-only over the API. (nullable, read only) - `dualPricingConsentedAmount` (number(double)): Gets or sets the card price amount (the card price minus the cash price, in the contract currency) that the cardholder's consent stated when they enrolled, for a merchant that posts a card price as the cash price plus a fixed amount. A card is never charged more than the cash price plus this amount under this contract. Null when the consent stated no card price, or stated it as a rate. Server-owned: recorded when the contract is created, on the terms of `dualPricingConsentedRate`, and read-only over the API. (nullable, read only) - `name` (string): Gets or sets the display name of the contract. (nullable) - `notes` (array<[EntityNote](https://devportal.signapay-sbx.winkpg.io/docs/api/models/EntityNote.md)>): Gets or sets the collection of notes attached to this contract. (nullable) - `tags` (array<[EntityTag](https://devportal.signapay-sbx.winkpg.io/docs/api/models/EntityTag.md)>): Gets or sets the collection of tags used to categorize this contract. (nullable) - `concurrencyStamp` (string): Gets or sets the concurrency stamp used for optimistic concurrency control. (nullable) - `entityVersion` (integer(int32)): Gets the entity version, incremented on each modification for optimistic concurrency. (read only) - `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. ### 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.signapay-sbx.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.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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" ] } ] } } ``` ### 401 Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 403 Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 404 Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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 } } ``` ### 500 Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 501 Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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 } } ``` ### Errors These statuses answer with the error envelope outlined below. - `400`: Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. - `401`: Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. - `403`: Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason. - `404`: Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found. - `500`: Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`. - `501`: Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. - `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.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) Fields: - `code` (string): (nullable) - `message` (string): (nullable) - `details` (string): (nullable) - `data` (object): (nullable) - `validationErrors` (array<[RemoteServiceValidationErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceValidationErrorInfo.md)>): (nullable) _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" ] } ] } } ``` ## Authentication - `ApiKey` ## 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 GetContractContinuationInput. See the Request body section below for its fields. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/contracts/list/continuation" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": false, "includeInactive": false, "includeApproxTotalCount": false }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": false, "includeInactive": false, "includeApproxTotalCount": false } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contracts/list/continuation' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, ContractsApi } from '@winkpg/winkpg-api'; const api = new ContractsApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.contractsGetContinuationList({ "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": false, "includeInactive": false, "includeApproxTotalCount": false }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/contracts/list/continuation', { method: 'POST', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": false, "includeInactive": false, "includeApproxTotalCount": 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 ContractsApi(config); var body = JsonSerializer.Deserialize(""" { "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": false, "includeInactive": false, "includeApproxTotalCount": false } """); var result = await api.ContractsGetContinuationListAsync(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/contracts/list/continuation"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": false, "includeInactive": false, "includeApproxTotalCount": 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.ContractsApi(client) body = winkpg_api.GetContractContinuationInput.from_dict({ "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": False, "includeInactive": False, "includeApproxTotalCount": False }) result = api.contracts_get_continuation_list(body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter": {}, "maxResultCount": 0, "continuationToken": "", "sorting": {}, "maxCreationTime": "2026-01-01T00:00:00Z", "minCreationTime": "2026-01-01T00:00:00Z", "maxModificationTime": "2026-01-01T00:00:00Z", "maxModifitionTime": "2026-01-01T00:00:00Z", "minModificationTime": "2026-01-01T00:00:00Z", "minModifitionTime": "2026-01-01T00:00:00Z", "includeDeleted": False, "includeInactive": False, "includeApproxTotalCount": False } response = requests.request( "POST", "{{BASE_URL}}/api/contracts/list/continuation", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.