# GET /api/invoicing/invoices/{id}/payment-link Invoices: Reads the invoice's pay-by-link state. Returns the absolute hosted-payment-page URL, when it lapses, the QR code URL and the backing session id. This read and the reissue below are the only endpoints that disclose the URL: it embeds a bearer credential, so it is deliberately absent from the invoice read and list payloads. The read never creates or rotates a link; re-send the invoice, or reissue the link, to mint a fresh one. **Operation ID:** `invoiceLifecycleGetPaymentLink` ## Authorization Requires: Invoicing.Invoices, merchant scope. Requires API key scope: `admin` Required permissions: - `Invoicing.Invoices` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 The invoice's link state. An invoice with no payable link answers 200 with `hasPaymentLink` false rather than an error: sending without a link is a designed outcome (no resolvable hosted page, an ambiguous merchant default, a biller that is not a merchant, nothing payable, or every payment-method feature off), as is the invalidation that follows full payment. **Content type:** `application/json` Schema: [`InvoicePaymentLinkInfoDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoicePaymentLinkInfoDto.md) Properties: - `invoiceId` (string(uuid)): The invoice the link pays. - `hasPaymentLink` (boolean): Whether the invoice currently carries a payment link at all. When `false`, every other link property is null and the invoice has no payable link to hand out. - `paymentUrl` (string): Absolute, HTTPS hosted-payment-page URL for the payer. Null when `hasPaymentLink` is `false`. (nullable) - `expiresAt` (string(date-time)): When the link stops working. Null when the invoice carries no link. (nullable) - `isExpired` (boolean): Whether `expiresAt` is already in the past. Computed server-side so the caller never has to compare against a client clock. Always `false` when there is no link. - `qrCodeUrl` (string): Public URL of the PNG QR code encoding `paymentUrl`. Null when the invoice has no link, or when QR generation was skipped or failed: generation is best-effort and never blocks a send, so a live link with no QR is a normal outcome rather than an error. (nullable) - `hppSessionId` (string(uuid)): The hosted-payment-page session backing the link. Null for an invoice with no link, and for a pre-cutover invoice still on the legacy opaque token. Safe to log and to quote in a support conversation, unlike the URL. (nullable) - `amountDue` (number(double)): Outstanding balance the link collects, in `currency`. - `currency` (string): ISO 4217 currency code of `amountDue`. (nullable) - `linkState` ([InvoicePaymentLinkState](https://devportal.demo.winkpg.io/docs/api/models/InvoicePaymentLinkState.md)): Whether the link still opens the payment page. `Spent` and `Revoked` come from the payment session behind the link; when that session cannot be read, the state falls back to `Live` or `Expired` from `expiresAt` alone. `None` exactly when `hasPaymentLink` is `false`. Values: - `None`: The invoice carries no payment link. - `Live`: The link opens the payment page and accepts a payment. - `Expired`: The link's expiry has passed, so it no longer opens the payment page. - `Spent`: A payer's attempt used the link up. It no longer opens the payment page. A referral, a pending or submitted authorization and a partial approval always spend the link, because money may already have moved; a decline spends it once its retries run out, or at once when the link does not reopen after a decline. - `Revoked`: The link was withdrawn (revoked or cancelled) and no longer opens the payment page. - `remainingDeclineRetries` (integer(int32)): How many more declined payment attempts the link can absorb and still reopen for the payer. Null when the link does not reopen after a decline, or when the payment session could not be read. (nullable) - `lastAttemptAt` (string(date-time)): When a payer last attempted a payment on the link: the attempt that spent it, or the most recent declined attempt the link reopened after. Null when no attempt is recorded, or when the payment session could not be read. (nullable) ### 403 The host has no usable public base URL to build the link against (`WinkPG.Invoicing:PaymentLinkBaseUrlNotConfigured`). A platform misconfiguration rather than an authorization refusal; the status is the historical one this code has always answered with. **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 The invoice does not exist or the caller cannot see it (`Invoicing:Invoice:NotFound`), or it belongs to another biller (`Invoicing:Biller:ForeignBillerNotAllowed`). **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/invoicing/invoices/{id}/payment-link" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/invoices/{id}/payment-link' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, InvoicingApi } from '@winkpg/winkpg-api'; const api = new InvoicingApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.invoiceLifecycleGetPaymentLink("3fa85f64-5717-4562-b3fc-2c963f66afa6"); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/{id}/payment-link', { 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 InvoicingApi(config); var result = await api.InvoiceLifecycleGetPaymentLinkAsync(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/invoicing/invoices/{id}/payment-link"); 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.InvoicingApi(client) result = api.invoice_lifecycle_get_payment_link("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/invoicing/invoices/{id}/payment-link", 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.