Invoices: Reads the invoice's pay-by-link state.

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/invoicing/invoices/{id}/payment-link" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/invoices/{id}/payment-link' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/{id}/payment-link', {
  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 InvoicingApi(config);
var result = await api.InvoiceLifecycleGetPaymentLinkAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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();

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.InvoicingApi(client)
    result = api.invoice_lifecycle_get_payment_link("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

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()

Parameters

Name In Type Description

id required

path

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

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.

Body: InvoicePaymentLinkInfoDto InvoicePaymentLinkInfoDto Each item has these fields.

Field Type Description

invoiceId required

string (uuid)

The invoice the link pays.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

hasPaymentLink required

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentUrl required

string

Absolute, HTTPS hosted-payment-page URL for the payer. Null when `hasPaymentLink` is `false`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

expiresAt required

string (date-time)

When the link stops working. Null when the invoice carries no link. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isExpired required

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

qrCodeUrl required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

hppSessionId required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

amountDue required

number (double)

Outstanding balance the link collects, in `currency`.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

currency required

string

ISO 4217 currency code of `amountDue`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

linkState required

InvoicePaymentLinkState InvoicePaymentLinkState

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: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastAttemptAt required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentLinkNotIssuedReason required

InvoicePaymentLinkNotIssuedReason InvoicePaymentLinkNotIssuedReason

Why the invoice holds no payment link: the reason its latest send went out without one, or the reason a later payment withdrew it. Null whenever `hasPaymentLink` is `true`, for an invoice that is not in a sent-and-open status, and when no reason was recorded (an invoice never sent, or a host that could not create links at all). Reason codes are stable and only ever appended; treat one you do not recognize as a generic "no payment link" reason. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`NothingPayable`	The invoice has nothing left to pay.
`BillerNotMerchant`	The invoice is not billed by a merchant, so hosted-page ownership cannot be confirmed.
`NoDefaultHostedPage`	The invoice names no hosted page and the merchant has no active payment page to default to.
`AmbiguousDefaultHostedPage`	The invoice names no hosted page and the merchant has more than one active payment page.
`NoPermittedPaymentMethod`	Every payment method the invoice allows is turned off for the merchant.
`HostedPageNotFound`	The hosted page the invoice targets was not found for the invoice's merchant. Covers a deleted page and a page that belongs to another merchant alike, by design.
`HostedPageInactive`	The hosted page the invoice targets is inactive.
`SessionRejected`	The hosted page refused the payment session for another reason; the metadata carries the stable error code.

This response has no documented body fields.

429 Too Many Requests

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 409 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden 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.
404 Not Found The invoice does not exist or the caller cannot see it (`Invoicing:Invoice:NotFound`), or it belongs to another biller (`Invoicing:Biller:ForeignBillerNotAllowed`).
409 Conflict The invoice is demo data, which never has a payment link (`Invoicing:DemoData:LiveActionNotAllowed`).
500 Internal Server Error 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 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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Invoicing

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Invoices: Reads the invoice's pay-by-link state.

Example request

Parameters

Request body

Responses

Errors

Authentication