# POST /api/merchants/{id}/billing/payment-method/capture-link/send

Payment Methods: Emails the merchant a capture link.

Sends a secure link for capturing a payment method for recurring billing.
The stored method is saved automatically when the merchant completes the hosted page, so no
operator follow-up is required.

**Operation ID:** `merchantBillingPaymentMethodSendCaptureLink`

## Authorization

Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `MerchantBilling.PaymentMethods`
- `MerchantBilling.PaymentMethods.Manage`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The billed merchant the captured token will be associated with. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The instrument kind and recipient email for the capture link.

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

Schema: [`SendMerchantBillingCaptureLinkInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SendMerchantBillingCaptureLinkInput.md)

Properties:
- `merchantId` (string(uuid)) required: The billed merchant the captured token will be associated with.
- `kind` ([MerchantBillingPaymentMethodKind](https://devportal.signapay-sbx.winkpg.io/docs/api/models/MerchantBillingPaymentMethodKind.md)): Card or ACH. Must be permitted by the reseller's allowlist.
  Values:
  - `Card`: Credit or debit card token. Brand, last 4, and expiry are populated.
  - `Ach`: ACH bank account token. AchAccountType and account last 4 are populated.
- `achAccountHolderType` ([MerchantBillingAchAccountHolderType](https://devportal.signapay-sbx.winkpg.io/docs/api/models/MerchantBillingAchAccountHolderType.md)): Whether the bank account the merchant will save belongs to the business or to a person. Applies when `kind` is ACH and is ignored for a card. It decides the SEC code the merchant's billing debits originate under: CCD for a business account, PPD for a personal one. (nullable)
  Values:
  - `Business`: A business bank account. Debited as a corporate (CCD) entry.
  - `Personal`: A personal bank account, such as a sole proprietor's. Debited as a consumer (PPD) entry.
- `recipientEmail` (string) required: The email address the capture link is sent to. The operator picks it from the merchant's users or enters it manually; the link itself is the only thing the email carries (no PCI data). (nullable)

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

Schema: [`SendMerchantBillingCaptureLinkInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SendMerchantBillingCaptureLinkInput.md)

Properties:
- `merchantId` (string(uuid)) required: The billed merchant the captured token will be associated with.
- `kind` ([MerchantBillingPaymentMethodKind](https://devportal.signapay-sbx.winkpg.io/docs/api/models/MerchantBillingPaymentMethodKind.md)): Card or ACH. Must be permitted by the reseller's allowlist.
  Values:
  - `Card`: Credit or debit card token. Brand, last 4, and expiry are populated.
  - `Ach`: ACH bank account token. AchAccountType and account last 4 are populated.
- `achAccountHolderType` ([MerchantBillingAchAccountHolderType](https://devportal.signapay-sbx.winkpg.io/docs/api/models/MerchantBillingAchAccountHolderType.md)): Whether the bank account the merchant will save belongs to the business or to a person. Applies when `kind` is ACH and is ignored for a card. It decides the SEC code the merchant's billing debits originate under: CCD for a business account, PPD for a personal one. (nullable)
  Values:
  - `Business`: A business bank account. Debited as a corporate (CCD) entry.
  - `Personal`: A personal bank account, such as a sole proprietor's. Debited as a consumer (PPD) entry.
- `recipientEmail` (string) required: The email address the capture link is sent to. The operator picks it from the merchant's users or enters it manually; the link itself is the only thing the email carries (no PCI data). (nullable)

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

Schema: [`SendMerchantBillingCaptureLinkInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SendMerchantBillingCaptureLinkInput.md)

Properties:
- `merchantId` (string(uuid)) required: The billed merchant the captured token will be associated with.
- `kind` ([MerchantBillingPaymentMethodKind](https://devportal.signapay-sbx.winkpg.io/docs/api/models/MerchantBillingPaymentMethodKind.md)): Card or ACH. Must be permitted by the reseller's allowlist.
  Values:
  - `Card`: Credit or debit card token. Brand, last 4, and expiry are populated.
  - `Ach`: ACH bank account token. AchAccountType and account last 4 are populated.
- `achAccountHolderType` ([MerchantBillingAchAccountHolderType](https://devportal.signapay-sbx.winkpg.io/docs/api/models/MerchantBillingAchAccountHolderType.md)): Whether the bank account the merchant will save belongs to the business or to a person. Applies when `kind` is ACH and is ignored for a card. It decides the SEC code the merchant's billing debits originate under: CCD for a business account, PPD for a personal one. (nullable)
  Values:
  - `Business`: A business bank account. Debited as a corporate (CCD) entry.
  - `Personal`: A personal bank account, such as a sole proprietor's. Debited as a consumer (PPD) entry.
- `recipientEmail` (string) required: The email address the capture link is sent to. The operator picks it from the merchant's users or enters it manually; the link itself is the only thing the email carries (no PCI data). (nullable)

## Responses

### 200

OK

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

Schema: [`SendMerchantBillingCaptureLinkResult`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/SendMerchantBillingCaptureLinkResult.md)

Properties:
- `recipientEmail` (string): The email address the capture link was sent to. (nullable)
- `expiresAt` (string(date-time)): When the capture link (and its bound session/intent) expires, in UTC.

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

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/merchants/{id}/billing/payment-method/capture-link/send" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recipientEmail": ""
}'
```

### PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recipientEmail": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/merchants/{id}/billing/payment-method/capture-link/send' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, MerchantBillingApi } from '@winkpg/winkpg-api';

const api = new MerchantBillingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.merchantBillingPaymentMethodSendCaptureLink("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recipientEmail": ""
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/merchants/{id}/billing/payment-method/capture-link/send', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "recipientEmail": ""
  }),
});

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 MerchantBillingApi(config);
var body = JsonSerializer.Deserialize<SendMerchantBillingCaptureLinkInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recipientEmail": ""
    }
    """);

var result = await api.MerchantBillingPaymentMethodSendCaptureLinkAsync(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/merchants/{id}/billing/payment-method/capture-link/send");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recipientEmail": ""
    }
    """, 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.MerchantBillingApi(client)
    body = winkpg_api.SendMerchantBillingCaptureLinkInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recipientEmail": ""
    })
    result = api.merchant_billing_payment_method_send_capture_link("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 = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recipientEmail": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/merchants/{id}/billing/payment-method/capture-link/send",
    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.