# POST /api/hostedpaymentpages/sessions/{sessionId}/pause

Pauses a payment link.

Takes the link out of service without spending or destroying it: it keeps its expiry, its
completion cap, its prefill and its completion history, and a resume puts it straight back
into service. A payer who opens a paused link sees the merchant's own message rather than
the generic out-of-service copy. Refused when the link has already reached a terminal status,
because a pause implies a resume and nothing can resume a link that is consumed, completed,
revoked or cancelled; the refusal carries that status's own error code, whose HTTP status is
published in the error catalogue rather than declared here (declaring any response on an
action suppresses the conventionally inferred 200 and drops the shared rate-limit response,
which is why the sibling revoke action declares none either).

**Operation ID:** `hppSessionPause`

## Authorization

Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope.

Requires API key scope: `transactions:write`

Required permissions:
- `HostedPaymentPage.HppSessions`
- `HostedPaymentPage.HppSessions.Create`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| sessionId | path | yes | string(uuid) | The session ID to pause. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The pause parameters. Its message replaces the one stored on the link; omitting it keeps
whatever the link already carries.

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

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

Properties:
- `inactiveMessage` (string): The message a payer sees instead of the generic out-of-service copy while this link is  paused, and after a reusable link has filled its completion cap. (nullable, max length 500)

_Example: Pause a link with a message for payers_

Takes the link out of service and sets the message a payer sees when they open it. The link keeps its expiry, completion cap, prefill and history, and a resume puts it back in service. Put the session id in the route. The message is plain text.

```json
{
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
}
```

_Example: Pause a link and keep its message_

Pauses the link and leaves its stored message as it is: omitting the message keeps whatever the link already carries.

```json
{ }
```

_Example: Pause a link and clear its message_

Pauses the link and clears its stored message, so a payer sees the generic out-of-service text instead.

```json
{
  "inactiveMessage": ""
}
```

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

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

Properties:
- `inactiveMessage` (string): The message a payer sees instead of the generic out-of-service copy while this link is  paused, and after a reusable link has filled its completion cap. (nullable, max length 500)

_Example: Pause a link with a message for payers_

Takes the link out of service and sets the message a payer sees when they open it. The link keeps its expiry, completion cap, prefill and history, and a resume puts it back in service. Put the session id in the route. The message is plain text.

```json
{
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
}
```

_Example: Pause a link and keep its message_

Pauses the link and leaves its stored message as it is: omitting the message keeps whatever the link already carries.

```json
{ }
```

_Example: Pause a link and clear its message_

Pauses the link and clears its stored message, so a payer sees the generic out-of-service text instead.

```json
{
  "inactiveMessage": ""
}
```

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

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

Properties:
- `inactiveMessage` (string): The message a payer sees instead of the generic out-of-service copy while this link is  paused, and after a reusable link has filled its completion cap. (nullable, max length 500)

_Example: Pause a link with a message for payers_

Takes the link out of service and sets the message a payer sees when they open it. The link keeps its expiry, completion cap, prefill and history, and a resume puts it back in service. Put the session id in the route. The message is plain text.

```json
{
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
}
```

_Example: Pause a link and keep its message_

Pauses the link and leaves its stored message as it is: omitting the message keeps whatever the link already carries.

```json
{ }
```

_Example: Pause a link and clear its message_

Pauses the link and clears its stored message, so a payer sees the generic out-of-service text instead.

```json
{
  "inactiveMessage": ""
}
```

## Responses

### 204

No content. The operation succeeded and returns no body.

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

These blocks send the Pause a link with a message for payers example. The other examples follow under Other request examples.

Takes the link out of service and sets the message a payer sees when they open it. The link keeps its expiry, completion cap, prefill and history, and a resume puts it back in service. Put the session id in the route. The message is plain text.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
}'
```

### PowerShell

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

$body = @'
{
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### 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.hppSessionPause("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
  }),
});

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 HostedPaymentPagesApi(config);
var body = JsonSerializer.Deserialize<PauseHppSessionInput>("""
    {
      "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
    }
    """);

var result = await api.HppSessionPauseAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/hostedpaymentpages/sessions/{sessionId}/pause");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
    }
    """, 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.HostedPaymentPagesApi(client)
    body = winkpg_api.PauseHppSessionInput.from_dict({
      "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
    })
    result = api.hpp_session_pause("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "inactiveMessage": "This payment link is on hold while we update your order. Please check back tomorrow."
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## Other request examples

Each example below is one request, shown in every language with the same placeholders.

### Pause a link and keep its message

Pauses the link and leaves its stored message as it is: omitting the message keeps whatever the link already carries.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{}'
```

#### PowerShell

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

$body = @'
{}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

#### 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.hppSessionPause("3fa85f64-5717-4562-b3fc-2c963f66afa6", {});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

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 HostedPaymentPagesApi(config);
var body = JsonSerializer.Deserialize<PauseHppSessionInput>("""
    {}
    """);

var result = await api.HppSessionPauseAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/hostedpaymentpages/sessions/{sessionId}/pause");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {}
    """, 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.HostedPaymentPagesApi(client)
    body = winkpg_api.PauseHppSessionInput.from_dict({})
    result = api.hpp_session_pause("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

### Pause a link and clear its message

Pauses the link and clears its stored message, so a payer sees the generic out-of-service text instead.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "inactiveMessage": ""
}'
```

#### PowerShell

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

$body = @'
{
  "inactiveMessage": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

#### 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.hppSessionPause("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "inactiveMessage": ""
});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "inactiveMessage": ""
  }),
});

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 HostedPaymentPagesApi(config);
var body = JsonSerializer.Deserialize<PauseHppSessionInput>("""
    {
      "inactiveMessage": ""
    }
    """);

var result = await api.HppSessionPauseAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/hostedpaymentpages/sessions/{sessionId}/pause");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "inactiveMessage": ""
    }
    """, 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.HostedPaymentPagesApi(client)
    body = winkpg_api.PauseHppSessionInput.from_dict({
      "inactiveMessage": ""
    })
    result = api.hpp_session_pause("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "inactiveMessage": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/pause",
    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.