# GET /api/hostedpaymentpages/sessions/{sessionId}/completions Lists the completions of one reusable payment link: one row per payer who arrived on it. A reusable link is never consumed itself, so this is where its payments are read: each row carries the transaction that payer produced, the state their visit ended in, and any vault token minted for them. A single-use session answers with an empty page rather than an error, so a caller need not know which kind of link it is holding before asking. **Operation ID:** `hppSessionGetCompletions` ## Authorization Requires: HostedPaymentPage.HppSessions, merchant scope. Requires API key scope: `transactions:read` Required permissions: - `HostedPaymentPage.HppSessions` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | sessionId | path | yes | string(uuid) | The session to list completions for. | | Sorting.Field | query | no | string | | | Sorting.Descending | query | no | boolean | | | MaxResultCount | query | no | integer(int32) | | | ContinuationToken | query | no | string | | | IncludeDeleted | query | no | boolean | | | IncludeInactive | query | no | boolean | | | IncludeApproxTotalCount | query | no | boolean | Accepted for interface compatibility and ignored: this listing never returns a count. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`ContinuationPagedResultDtoOfHppSessionCompletionDto`](https://devportal.demo.winkpg.io/docs/api/models/ContinuationPagedResultDtoOfHppSessionCompletionDto.md) Properties: - `items` (array<[HppSessionCompletionDto](https://devportal.demo.winkpg.io/docs/api/models/HppSessionCompletionDto.md)>): The items returned for this page. (nullable) Fields of each item: - `id` (string(uuid)): The completion's own identifier, which is also the session id this payer's surfaces and their resulting transaction were keyed on. - `parentSessionId` (string(uuid)): The reusable session this visit belongs to. - `hostedPageId` (string(uuid)): The hosted payment page the link targets. - `merchantId` (string(uuid)): The merchant that owns the hosted payment page. - `shortToken` (string): The short URL token of the link this payer arrived through. (nullable) - `status` ([HppSessionStatus](https://devportal.demo.winkpg.io/docs/api/models/HppSessionStatus.md)): The visit's persisted status. Values: - `Pending`: The session has been created and is awaiting use by a customer. Also the status a session returns to when a premature consume is released: a submission that was rejected by pure request-shape validation before the orchestrator was invoked leaves the link usable, so the payer can correct their input and resubmit on the same link (see Consumed). - `Consumed`: The session has been consumed by a transaction submission. Terminal in practice: the only exit is the narrow release back to Pending performed by HppSession.ReleaseConsume, which requires that the session carries no OrchestratorDispatchedAt marker, that the consuming transaction id is still the one recorded, and that no vault token was minted. Once a submission reaches the orchestrator the marker is durable and the session stays Consumed regardless of the outcome, including a decline. Submit paths additionally validate the request BEFORE consuming, so a rejected request usually never spends the link in the first place; the release covers the rules that can only run inside the create. - `Revoked`: The session has been manually revoked by an administrator. - `Cancelled`: The session was cancelled by the parent page via the iframe two-way command channel Distinct from Revoked (admin-initiated) for clarity in audit + reporting: same terminal effect (session can no longer be consumed). - `Completed`: A reusable link has taken every completion it was capped at, so it accepts no further payers. Terminal, and reachable only on a reusable session: a single-use link spends itself through Consumed instead, and a reusable one is never Consumed because its per-payer consume state lives on its HppSessionCompletion children rather than on the parent. A reusable link created with no cap never reaches this status; it stays payable until it is revoked, cancelled or expires. - `derivedState` ([HppSessionDerivedState](https://devportal.demo.winkpg.io/docs/api/models/HppSessionDerivedState.md)): The state a reader should see for this visit: the stored status when it is terminal, otherwise usable or expired by the clock. Values: - `Usable`: Pending and not yet past its expiry instant: the link can still be presented and consumed. - `Expired`: Pending, but the expiry instant has passed. The document may still be readable for the retention window configured by HostedPaymentPageSettings.SessionExpiredRetentionDays, which is what lets a payer see a distinct expired page and an administrator see the row on a grid. - `Consumed`: Consumed by a transaction submission (Consumed). - `Revoked`: Revoked by an administrator (Revoked). - `Cancelled`: Cancelled by the parent page over the iframe command channel (Cancelled). - `Completed`: A reusable link that has taken its last capped completion (Completed). The reusable analogue of Consumed: the link is spent, but by many payers rather than one. - `Paused`: The merchant has paused the link. Unlike every other non-usable state this one is reversible: a resume puts the link straight back to Usable with its expiry, cap and prefill untouched. A payer who opens a paused link sees the merchant's own inactive message rather than the generic out-of-service copy. - `createdAt` (string(date-time)): When this visit was minted, in UTC. - `expiresAt` (string(date-time)): When the link expires, in UTC, or `null` for a link that does not expire. (nullable) - `consumedByTransactionId` (string(uuid)): The transaction that completed this visit, or `null`. (nullable) - `consumedAt` (string(date-time)): When this visit was consumed, in UTC, or `null`. (nullable) - `vaultedPaymentTokenId` (string(uuid)): The vault token minted for this payer by a direct-vault reservation, or `null`. (nullable) - `declineRetryMode` ([HppDeclineRetryMode](https://devportal.demo.winkpg.io/docs/api/models/HppDeclineRetryMode.md)): The decline-retry policy this visit inherited from the link. (nullable) Values: - `ConsumeOnDecline`: The historical behavior, and the default at every level of the resolution chain. Any processor answer spends the link permanently: the session stays Consumed and a payer who reloads it is told the link has already been used. - `ReleaseOnDecline`: A definite issuer decline hands the link back to Pending so the payer can correct their card and resubmit on the same URL, instead of having to ask the merchant for a new link. - `declineReleaseCount` (integer(int32)): How many decline releases this payer has spent, or `null` for none. (nullable) - `lastDeclinedTransactionId` (string(uuid)): The transaction whose decline last reopened this visit, or `null`. (nullable) - `lastDeclineReleasedAt` (string(date-time)): When this visit was last reopened after a decline, in UTC, or `null`. (nullable) - `consumedOrder` ([HppCatalogOrder](https://devportal.demo.winkpg.io/docs/api/models/HppCatalogOrder.md)): The catalog order this payer bought, resolved and priced by the platform when they paid, or `null` until then (and always on a link off a page that sells no products). - `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. ### cURL ```bash curl -X GET "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/completions" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/completions' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, HostedPaymentPagesApi } from '@winkpg/winkpg-api'; const api = new HostedPaymentPagesApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.hppSessionGetCompletions("3fa85f64-5717-4562-b3fc-2c963f66afa6"); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/completions', { method: 'GET', headers: { "api-key": "{{API_KEY}}", }, }); 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; var config = new Configuration { BasePath = "{{BASE_URL}}" }; config.AddApiKey("api-key", "{{API_KEY}}"); var api = new HostedPaymentPagesApi(config); var result = await api.HppSessionGetCompletionsAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6")); ``` ### C# (raw HTTP) ```csharp using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/hostedpaymentpages/sessions/{sessionId}/completions"); request.Headers.Add("api-key", "{{API_KEY}}"); 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.HostedPaymentPagesApi(client) result = api.hpp_session_get_completions("3fa85f64-5717-4562-b3fc-2c963f66afa6") ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", } response = requests.request( "GET", "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/completions", headers=headers, ) 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.