# POST /api/stored-credential-consents/consent-config

Stored Credential Consents: Gets the consent text to show the cardholder.

Returns the rendered consent text for your merchant, its `version`, whether consent is
required, and the disclosure links. Show the cardholder `text.rendered`, then send
`text.version` as `consentTextVersion` when you record the consent with a token create.
The platform keeps the exact text with the consent, and the consent read returns it.

**Operation ID:** `consentConfigGet`

## Authorization

Requires: StoredCredentialConsents.StoredCredentialConsents, merchant scope.

Requires API key scope: `customers`

Required permissions:
- `StoredCredentialConsents.StoredCredentialConsents`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The usages to render and any disclosures to state in the text.

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

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

Properties:
- `usage` ([StoredCredentialUsage](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredCredentialUsage.md)): Filter for which `StoredCredentialUsage` scopes to render bullets for. When null or `None`, all permitted scopes render; the caller is expected to be rendering a generic consent page. 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. (nullable)
  Values:
  - `None`: No permitted uses. Consent record is effectively inactive.
  - `Recurring`: Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring.
  - `Installment`: Fixed-schedule installment plans dividing a known total. Maps to Installment.
  - `UnscheduledCOF`: Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth.
  - `OneTimeFuture`: A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs.
- `merchantName` (string): Merchant name to substitute into `{{MerchantName}}`. Optional. When unset, the service falls back to the authenticated merchant's display name. Conditional: When MerchantName is not null. Max length: 200. (nullable)
- `kind` ([ConsentPaymentKind](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentPaymentKind.md)): Which payment instrument the consent applies to. Selects the card vs ACH sibling template and the matching tokenization-protection wording. Defaults to `Card`.
  Values:
  - `Card`: Card credentials. Renders ConsentTemplateNames.Consent (the default).
  - `Ach`: Bank account (ACH). Renders ConsentTemplateNames.AchConsent.
- `convenienceFeeDisclosure` (string): Free-text description of a convenience fee the cardholder will be charged on every charge under this authorization (e.g. "$2.50 per payment"). Substituted into Section 3 of the rendered text; when null or blank, the fee line does not render at all. Conditional: When ConvenienceFeeDisclosure is not null. Max length: 500. (nullable)
- `cardPriceDisclosure` (string): Free-text statement of the card price charged to a card on every charge under this authorization, for a merchant that posts a cash price and a card price (e.g. "$104.00 per payment, against a cash price of $100.00"). Substituted into Section 3 of the rendered text; when null or blank, the card price line does not render at all. Card consents only. Conditional: When CardPriceDisclosure is not null. Max length: 500. (nullable)
- `surchargeDisclosure` (string): Statement of the surcharge ceiling a recurring or installment charge to a card may carry (e.g. "up to 3 percent of each payment, added to the amount above when a credit card is charged"). Substituted into Section 3 of the rendered text; when null or blank, the surcharge line does not render at all. Card consents only. Conditional: When SurchargeDisclosure is not null. Max length: 500. (nullable)

_Example: Card saved for recurring payments_

Gets the text to show a cardholder who is saving a card for a subscription. Show the returned text next to the consent checkbox, then send the returned version as consentTextVersion when you store the card. Omit merchantName to use your merchant's display name.

```json
{
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
}
```

_Example: Card saved for recurring payments with a convenience fee_

Gets the subscription consent text with the convenience fee every charge carries, so the cardholder agrees to the fee before the first charge. Pass only a fee your charges actually assess.

```json
{
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
}
```

_Example: Bank account saved for future payments_

Gets the bank account authorization text for a customer saving a bank account to pay later invoices on request.

```json
{
  "usage": "UnscheduledCOF",
  "kind": "Ach"
}
```

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

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

Properties:
- `usage` ([StoredCredentialUsage](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredCredentialUsage.md)): Filter for which `StoredCredentialUsage` scopes to render bullets for. When null or `None`, all permitted scopes render; the caller is expected to be rendering a generic consent page. 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. (nullable)
  Values:
  - `None`: No permitted uses. Consent record is effectively inactive.
  - `Recurring`: Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring.
  - `Installment`: Fixed-schedule installment plans dividing a known total. Maps to Installment.
  - `UnscheduledCOF`: Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth.
  - `OneTimeFuture`: A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs.
- `merchantName` (string): Merchant name to substitute into `{{MerchantName}}`. Optional. When unset, the service falls back to the authenticated merchant's display name. Conditional: When MerchantName is not null. Max length: 200. (nullable)
- `kind` ([ConsentPaymentKind](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentPaymentKind.md)): Which payment instrument the consent applies to. Selects the card vs ACH sibling template and the matching tokenization-protection wording. Defaults to `Card`.
  Values:
  - `Card`: Card credentials. Renders ConsentTemplateNames.Consent (the default).
  - `Ach`: Bank account (ACH). Renders ConsentTemplateNames.AchConsent.
- `convenienceFeeDisclosure` (string): Free-text description of a convenience fee the cardholder will be charged on every charge under this authorization (e.g. "$2.50 per payment"). Substituted into Section 3 of the rendered text; when null or blank, the fee line does not render at all. Conditional: When ConvenienceFeeDisclosure is not null. Max length: 500. (nullable)
- `cardPriceDisclosure` (string): Free-text statement of the card price charged to a card on every charge under this authorization, for a merchant that posts a cash price and a card price (e.g. "$104.00 per payment, against a cash price of $100.00"). Substituted into Section 3 of the rendered text; when null or blank, the card price line does not render at all. Card consents only. Conditional: When CardPriceDisclosure is not null. Max length: 500. (nullable)
- `surchargeDisclosure` (string): Statement of the surcharge ceiling a recurring or installment charge to a card may carry (e.g. "up to 3 percent of each payment, added to the amount above when a credit card is charged"). Substituted into Section 3 of the rendered text; when null or blank, the surcharge line does not render at all. Card consents only. Conditional: When SurchargeDisclosure is not null. Max length: 500. (nullable)

_Example: Card saved for recurring payments_

Gets the text to show a cardholder who is saving a card for a subscription. Show the returned text next to the consent checkbox, then send the returned version as consentTextVersion when you store the card. Omit merchantName to use your merchant's display name.

```json
{
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
}
```

_Example: Card saved for recurring payments with a convenience fee_

Gets the subscription consent text with the convenience fee every charge carries, so the cardholder agrees to the fee before the first charge. Pass only a fee your charges actually assess.

```json
{
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
}
```

_Example: Bank account saved for future payments_

Gets the bank account authorization text for a customer saving a bank account to pay later invoices on request.

```json
{
  "usage": "UnscheduledCOF",
  "kind": "Ach"
}
```

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

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

Properties:
- `usage` ([StoredCredentialUsage](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredCredentialUsage.md)): Filter for which `StoredCredentialUsage` scopes to render bullets for. When null or `None`, all permitted scopes render; the caller is expected to be rendering a generic consent page. 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. (nullable)
  Values:
  - `None`: No permitted uses. Consent record is effectively inactive.
  - `Recurring`: Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring.
  - `Installment`: Fixed-schedule installment plans dividing a known total. Maps to Installment.
  - `UnscheduledCOF`: Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth.
  - `OneTimeFuture`: A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs.
- `merchantName` (string): Merchant name to substitute into `{{MerchantName}}`. Optional. When unset, the service falls back to the authenticated merchant's display name. Conditional: When MerchantName is not null. Max length: 200. (nullable)
- `kind` ([ConsentPaymentKind](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentPaymentKind.md)): Which payment instrument the consent applies to. Selects the card vs ACH sibling template and the matching tokenization-protection wording. Defaults to `Card`.
  Values:
  - `Card`: Card credentials. Renders ConsentTemplateNames.Consent (the default).
  - `Ach`: Bank account (ACH). Renders ConsentTemplateNames.AchConsent.
- `convenienceFeeDisclosure` (string): Free-text description of a convenience fee the cardholder will be charged on every charge under this authorization (e.g. "$2.50 per payment"). Substituted into Section 3 of the rendered text; when null or blank, the fee line does not render at all. Conditional: When ConvenienceFeeDisclosure is not null. Max length: 500. (nullable)
- `cardPriceDisclosure` (string): Free-text statement of the card price charged to a card on every charge under this authorization, for a merchant that posts a cash price and a card price (e.g. "$104.00 per payment, against a cash price of $100.00"). Substituted into Section 3 of the rendered text; when null or blank, the card price line does not render at all. Card consents only. Conditional: When CardPriceDisclosure is not null. Max length: 500. (nullable)
- `surchargeDisclosure` (string): Statement of the surcharge ceiling a recurring or installment charge to a card may carry (e.g. "up to 3 percent of each payment, added to the amount above when a credit card is charged"). Substituted into Section 3 of the rendered text; when null or blank, the surcharge line does not render at all. Card consents only. Conditional: When SurchargeDisclosure is not null. Max length: 500. (nullable)

_Example: Card saved for recurring payments_

Gets the text to show a cardholder who is saving a card for a subscription. Show the returned text next to the consent checkbox, then send the returned version as consentTextVersion when you store the card. Omit merchantName to use your merchant's display name.

```json
{
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
}
```

_Example: Card saved for recurring payments with a convenience fee_

Gets the subscription consent text with the convenience fee every charge carries, so the cardholder agrees to the fee before the first charge. Pass only a fee your charges actually assess.

```json
{
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
}
```

_Example: Bank account saved for future payments_

Gets the bank account authorization text for a customer saving a bank account to pay later invoices on request.

```json
{
  "usage": "UnscheduledCOF",
  "kind": "Ach"
}
```

## Responses

### 200

The consent text and its version.

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

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

Properties:
- `isConsentRequired` (boolean): True when the authenticated merchant's scope has consent capture enforced. A transaction that tokenizes/persists a card without a `StoredCredentialConsentInput` will be rejected with `stored_credential_consent_required`.
- `allowedUsages` ([StoredCredentialUsage](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredCredentialUsage.md)): The usage scopes the merchant's configuration permits. Matches the flags that can legitimately appear on captured consents for this merchant; consumers render only the matching checkboxes / bullets. 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.
  Values:
  - `None`: No permitted uses. Consent record is effectively inactive.
  - `Recurring`: Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring.
  - `Installment`: Fixed-schedule installment plans dividing a known total. Maps to Installment.
  - `UnscheduledCOF`: Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth.
  - `OneTimeFuture`: A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs.
- `text` ([ConsentTextConfigDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentTextConfigDto.md)): Rendered consent text with version metadata.
  Fields:
  - `version` (string): Version hash of the rendered template. Clients persist this and submit it back on the transaction so WinkPG records exactly what the cardholder saw. (nullable)
  - `rendered` (string): Fully-rendered, substituted consent text with merchant variables applied. No `{{Variable}}` markers should remain in well-configured merchants; any that do are surfaced via `missingVariables` for diagnosis. (nullable)
  - `locale` (string): Locale of the rendered text. Single-locale (en-US) for v1. (nullable)
  - `lastUpdatedAt` (string(date-time)): Reserved. Always `1970-01-01T00:00:00Z` today; `version` is the identity of the text.
  - `missingVariables` (array<string>): Reserved for the names of template variables that had no value at render time. Always empty today. (nullable)
- `disclosures` ([ConsentDisclosuresDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentDisclosuresDto.md)): Merchant-configured disclosure URLs referenced from the consent text.
  Fields:
  - `termsUrl` (string): Merchant's terms of service URL. Empty when not configured. (nullable)
  - `privacyUrl` (string): Merchant's privacy policy URL. Empty when not configured. (nullable)

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

These blocks send the Card saved for recurring payments example. The other examples follow under Other request examples.

Gets the text to show a cardholder who is saving a card for a subscription. Show the returned text next to the consent checkbox, then send the returned version as consentTextVersion when you store the card. Omit merchantName to use your merchant's display name.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/stored-credential-consents/consent-config" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
}'
```

### PowerShell

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

$body = @'
{
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/stored-credential-consents/consent-config' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

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

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

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

const { data } = await api.consentConfigGet({
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/stored-credential-consents/consent-config', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "usage": "Recurring",
    "merchantName": "Acme Fitness",
    "kind": "Card"
  }),
});

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 StoredCredentialConsentsApi(config);
var body = JsonSerializer.Deserialize<GetConsentConfigInput>("""
    {
      "usage": "Recurring",
      "merchantName": "Acme Fitness",
      "kind": "Card"
    }
    """);

var result = await api.ConsentConfigGetAsync(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/stored-credential-consents/consent-config");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "usage": "Recurring",
      "merchantName": "Acme Fitness",
      "kind": "Card"
    }
    """, 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.StoredCredentialConsentsApi(client)
    body = winkpg_api.GetConsentConfigInput.from_dict({
      "usage": "Recurring",
      "merchantName": "Acme Fitness",
      "kind": "Card"
    })
    result = api.consent_config_get(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "usage": "Recurring",
  "merchantName": "Acme Fitness",
  "kind": "Card"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/stored-credential-consents/consent-config",
    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.

### Card saved for recurring payments with a convenience fee

Gets the subscription consent text with the convenience fee every charge carries, so the cardholder agrees to the fee before the first charge. Pass only a fee your charges actually assess.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/stored-credential-consents/consent-config" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
}'
```

#### PowerShell

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

$body = @'
{
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/stored-credential-consents/consent-config' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

#### TypeScript (SDK)

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

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

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

const { data } = await api.consentConfigGet({
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/stored-credential-consents/consent-config', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "usage": "Recurring",
    "kind": "Card",
    "convenienceFeeDisclosure": "$2.50 per payment"
  }),
});

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 StoredCredentialConsentsApi(config);
var body = JsonSerializer.Deserialize<GetConsentConfigInput>("""
    {
      "usage": "Recurring",
      "kind": "Card",
      "convenienceFeeDisclosure": "$2.50 per payment"
    }
    """);

var result = await api.ConsentConfigGetAsync(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/stored-credential-consents/consent-config");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "usage": "Recurring",
      "kind": "Card",
      "convenienceFeeDisclosure": "$2.50 per payment"
    }
    """, 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.StoredCredentialConsentsApi(client)
    body = winkpg_api.GetConsentConfigInput.from_dict({
      "usage": "Recurring",
      "kind": "Card",
      "convenienceFeeDisclosure": "$2.50 per payment"
    })
    result = api.consent_config_get(body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "usage": "Recurring",
  "kind": "Card",
  "convenienceFeeDisclosure": "$2.50 per payment"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/stored-credential-consents/consent-config",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

### Bank account saved for future payments

Gets the bank account authorization text for a customer saving a bank account to pay later invoices on request.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/stored-credential-consents/consent-config" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "usage": "UnscheduledCOF",
  "kind": "Ach"
}'
```

#### PowerShell

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

$body = @'
{
  "usage": "UnscheduledCOF",
  "kind": "Ach"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/stored-credential-consents/consent-config' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

#### TypeScript (SDK)

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

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

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

const { data } = await api.consentConfigGet({
  "usage": "UnscheduledCOF",
  "kind": "Ach"
});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/stored-credential-consents/consent-config', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "usage": "UnscheduledCOF",
    "kind": "Ach"
  }),
});

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 StoredCredentialConsentsApi(config);
var body = JsonSerializer.Deserialize<GetConsentConfigInput>("""
    {
      "usage": "UnscheduledCOF",
      "kind": "Ach"
    }
    """);

var result = await api.ConsentConfigGetAsync(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/stored-credential-consents/consent-config");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "usage": "UnscheduledCOF",
      "kind": "Ach"
    }
    """, 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.StoredCredentialConsentsApi(client)
    body = winkpg_api.GetConsentConfigInput.from_dict({
      "usage": "UnscheduledCOF",
      "kind": "Ach"
    })
    result = api.consent_config_get(body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "usage": "UnscheduledCOF",
  "kind": "Ach"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/stored-credential-consents/consent-config",
    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.