# POST /api/merchants/{id}/payment-encryption-bindings/{providerName}/test-connection
Payment encryption: tests the connection to the bound provider.
The probe calls the provider's health command: it decrypts nothing, sends no key reference, and never
touches a payment path. It carries back no vendor response body and no credential material. A candidate
body is used for the probe and nothing else: it is never persisted, never logged, and never echoed in
the response.
**Operation ID:** `merchantPaymentEncryptionBindingTestPaymentEncryptionBindingConnection`
## Authorization
Requires: Merchants.Merchants.Update, merchant scope.
Requires API key scope: `admin`
Required permissions:
- `Merchants.Merchants.Update`
## Parameters
| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The merchant id. |
| providerName | path | yes | string | The provider to probe. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |
## Request Body
Optional candidate credentials to probe instead of the stored ones, so a boarding can be tested before
it is saved. Omit the body to probe the binding as stored.
**Content type:** `application/json`
Schema: [`MerchantPaymentEncryptionBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantPaymentEncryptionBinding.md)
Properties:
- `providerName` (string): Which payment encryption provider this entry binds the merchant to, by the provider's registered name. Compared case-insensitively. A null or blank provider is treated as no binding at all, so an incompletely boarded row cannot silently become a live selection. Required: When IsEnabled is true. (nullable, max length 64)
- `isEnabled` (boolean): Master enable flag for this provider on this merchant. When `false` or null, the selector must not return this binding even though the row exists. (nullable)
- `credentialSource` ([PaymentEncryptionCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionCredentialSource.md)): Whose provider account the decryption calls are billed to. Null reads as `Gateway`. (nullable)
Values:
- `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credentialSource reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
- `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[PaymentEncryptionBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionBindingFieldValue.md)>): The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Secret values are stored encrypted and are stripped, not decrypted, on every read that leaves the server. Only the server-side call to the provider ever uses the plaintext. Empty for a `Gateway` binding, whose values are filled in at read time from the host-scoped provider settings instead. A gateway-sourced row that carried values would be a copy of the gateway's credentials living on a merchant document. Conditional: When FieldValues is not null. (nullable)
Fields of each item:
- `key` (string): The provider setting name this value belongs to, matching a `PaymentEncryptionSettingFieldDefinition.SettingName` the provider's contributor declares. Compared case-insensitively. (nullable)
- `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and `null` on every read that leaves the server. (nullable)
- `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
- `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an empty one without the value ever being sent. (nullable)
- `keyEntries` (array<[PaymentEncryptionKeyEntry](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionKeyEntry.md)>): The key serial identifier entries that map an inbound key serial number to an HSM key. Conditional: When KeyEntries is not null. (nullable)
Fields of each item:
- `ksi` (string) required: The key serial identifier: six to ten significant hex characters, stored upper-case with leading `F` padding stripped. Unique within a binding. Conditional: When Ksi is not empty. (nullable)
- `label` (string): An operator-facing label for this key, such as the device family it was injected into. Shown wherever the key reference itself must not be. (nullable, max length 100)
- `scheme` ([PaymentEncryptionScheme](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionScheme.md)): Which encryption scheme the terminals under this key produce. Required: When Status != Deactivated. (nullable)
Values:
- `Dukpt`: Generic DUKPT (ANSI X9.24 data variant), TDES or AES.
- `OnGuard`: The Ingenico On-Guard protocol.
- `dukptMode` ([PaymentEncryptionDukptMode](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionDukptMode.md)): The DUKPT key derivation algorithm this key uses. (nullable)
Values:
- `Tdes`: Triple DES DUKPT (ANSI X9.24 Part 1).
- `Aes`: AES DUKPT (ANSI X9.24 Part 3). Carries a working-key type alongside it.
- `aesWorkingKeyType` (string): The AES working-key type, required when `dukptMode` is `Aes` and meaningless otherwise. A provider token value rather than an enum, because the vocabulary belongs to the vendor's command set. Required: When DukptMode == Aes. Conditional: When DukptMode is not null and DukptMode != Aes. (nullable, max length 16)
- `keyReference` (string): The HSM key reference: a storage-table slot or a wrapped key block. Always stored encrypted, and never returned on a read that leaves the server. (nullable, max length 1024)
- `isKeyReferenceConfigured` (boolean): Whether a key reference is stored, set on reads so an operator can tell a configured key from an empty one without the reference ever being sent. Server-owned: the save paths ignore whatever arrives here. (nullable)
- `majorKey` (string): The major key the reference is stored under, in the provider's own token vocabulary. Null leaves the provider's default in force. (nullable, max length 16)
- `onGuardExtendedEncryption` (boolean): On-Guard extended encryption, when the device family uses it. Meaningful only when `scheme` is `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. (nullable)
- `onGuardEndingPanDigitsEncrypted` (boolean): Whether the device family encrypts the ending PAN digits. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. (nullable)
- `onGuardClearPanDigits` (integer(int32)): How many leading PAN digits the device family leaves in the clear. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. Conditional: When OnGuardClearPanDigits is not null. Range: 0 to 6. (nullable)
- `status` ([PaymentEncryptionKeyEntryStatus](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionKeyEntryStatus.md)): Whether the entry may be matched. Null reads as `Deactivated`: an entry whose status nobody set has not been through the boarding step that activates it, and matching it would use a key the platform cannot confirm is live. (nullable)
Values:
- `Active`: The entry may be matched against an inbound key serial number.
- `Deactivated`: The entry is retired. It stays readable for explaining past transactions, and is never matched.
- `requireMac` (boolean): Reserved: whether the device family attaches a MAC that should be verified during decryption. (nullable)
- `createdAtUtc` (string(date-time)): When the entry was created, in UTC. (nullable)
- `statusChangedAtUtc` (string(date-time)): When `status` last changed, in UTC. Separate from the audit log because it is shown on the key table itself, where an operator decides whether a key is still in rotation. (nullable)
- `primaryEndpoint` (string): The primary provider endpoint for this merchant, or null to use the provider's own configured endpoint. HTTPS-only, enforced by the binding validator. Conditional: When PrimaryEndpoint is not empty. (nullable, max length 512)
- `secondaryEndpoint` (string): The secondary provider endpoint, used when the primary does not answer. HTTPS-only. Null when the merchant is bound to one region only. Conditional: When SecondaryEndpoint is not empty. Conditional: When SecondaryEndpoint is not empty and PrimaryEndpoint is empty. (nullable, max length 512)
- `decryptTimeoutMillisecondsOverride` (integer(int32)): A per-merchant override of the gateway-wide decryption budget, in milliseconds, or null to use the gateway setting. Conditional: When DecryptTimeoutMillisecondsOverride is not null. Range: 250 to 30000. (nullable)
**Content type:** `text/json`
Schema: [`MerchantPaymentEncryptionBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantPaymentEncryptionBinding.md)
Properties:
- `providerName` (string): Which payment encryption provider this entry binds the merchant to, by the provider's registered name. Compared case-insensitively. A null or blank provider is treated as no binding at all, so an incompletely boarded row cannot silently become a live selection. Required: When IsEnabled is true. (nullable, max length 64)
- `isEnabled` (boolean): Master enable flag for this provider on this merchant. When `false` or null, the selector must not return this binding even though the row exists. (nullable)
- `credentialSource` ([PaymentEncryptionCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionCredentialSource.md)): Whose provider account the decryption calls are billed to. Null reads as `Gateway`. (nullable)
Values:
- `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credentialSource reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
- `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[PaymentEncryptionBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionBindingFieldValue.md)>): The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Secret values are stored encrypted and are stripped, not decrypted, on every read that leaves the server. Only the server-side call to the provider ever uses the plaintext. Empty for a `Gateway` binding, whose values are filled in at read time from the host-scoped provider settings instead. A gateway-sourced row that carried values would be a copy of the gateway's credentials living on a merchant document. Conditional: When FieldValues is not null. (nullable)
Fields of each item:
- `key` (string): The provider setting name this value belongs to, matching a `PaymentEncryptionSettingFieldDefinition.SettingName` the provider's contributor declares. Compared case-insensitively. (nullable)
- `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and `null` on every read that leaves the server. (nullable)
- `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
- `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an empty one without the value ever being sent. (nullable)
- `keyEntries` (array<[PaymentEncryptionKeyEntry](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionKeyEntry.md)>): The key serial identifier entries that map an inbound key serial number to an HSM key. Conditional: When KeyEntries is not null. (nullable)
Fields of each item:
- `ksi` (string) required: The key serial identifier: six to ten significant hex characters, stored upper-case with leading `F` padding stripped. Unique within a binding. Conditional: When Ksi is not empty. (nullable)
- `label` (string): An operator-facing label for this key, such as the device family it was injected into. Shown wherever the key reference itself must not be. (nullable, max length 100)
- `scheme` ([PaymentEncryptionScheme](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionScheme.md)): Which encryption scheme the terminals under this key produce. Required: When Status != Deactivated. (nullable)
Values:
- `Dukpt`: Generic DUKPT (ANSI X9.24 data variant), TDES or AES.
- `OnGuard`: The Ingenico On-Guard protocol.
- `dukptMode` ([PaymentEncryptionDukptMode](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionDukptMode.md)): The DUKPT key derivation algorithm this key uses. (nullable)
Values:
- `Tdes`: Triple DES DUKPT (ANSI X9.24 Part 1).
- `Aes`: AES DUKPT (ANSI X9.24 Part 3). Carries a working-key type alongside it.
- `aesWorkingKeyType` (string): The AES working-key type, required when `dukptMode` is `Aes` and meaningless otherwise. A provider token value rather than an enum, because the vocabulary belongs to the vendor's command set. Required: When DukptMode == Aes. Conditional: When DukptMode is not null and DukptMode != Aes. (nullable, max length 16)
- `keyReference` (string): The HSM key reference: a storage-table slot or a wrapped key block. Always stored encrypted, and never returned on a read that leaves the server. (nullable, max length 1024)
- `isKeyReferenceConfigured` (boolean): Whether a key reference is stored, set on reads so an operator can tell a configured key from an empty one without the reference ever being sent. Server-owned: the save paths ignore whatever arrives here. (nullable)
- `majorKey` (string): The major key the reference is stored under, in the provider's own token vocabulary. Null leaves the provider's default in force. (nullable, max length 16)
- `onGuardExtendedEncryption` (boolean): On-Guard extended encryption, when the device family uses it. Meaningful only when `scheme` is `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. (nullable)
- `onGuardEndingPanDigitsEncrypted` (boolean): Whether the device family encrypts the ending PAN digits. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. (nullable)
- `onGuardClearPanDigits` (integer(int32)): How many leading PAN digits the device family leaves in the clear. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. Conditional: When OnGuardClearPanDigits is not null. Range: 0 to 6. (nullable)
- `status` ([PaymentEncryptionKeyEntryStatus](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionKeyEntryStatus.md)): Whether the entry may be matched. Null reads as `Deactivated`: an entry whose status nobody set has not been through the boarding step that activates it, and matching it would use a key the platform cannot confirm is live. (nullable)
Values:
- `Active`: The entry may be matched against an inbound key serial number.
- `Deactivated`: The entry is retired. It stays readable for explaining past transactions, and is never matched.
- `requireMac` (boolean): Reserved: whether the device family attaches a MAC that should be verified during decryption. (nullable)
- `createdAtUtc` (string(date-time)): When the entry was created, in UTC. (nullable)
- `statusChangedAtUtc` (string(date-time)): When `status` last changed, in UTC. Separate from the audit log because it is shown on the key table itself, where an operator decides whether a key is still in rotation. (nullable)
- `primaryEndpoint` (string): The primary provider endpoint for this merchant, or null to use the provider's own configured endpoint. HTTPS-only, enforced by the binding validator. Conditional: When PrimaryEndpoint is not empty. (nullable, max length 512)
- `secondaryEndpoint` (string): The secondary provider endpoint, used when the primary does not answer. HTTPS-only. Null when the merchant is bound to one region only. Conditional: When SecondaryEndpoint is not empty. Conditional: When SecondaryEndpoint is not empty and PrimaryEndpoint is empty. (nullable, max length 512)
- `decryptTimeoutMillisecondsOverride` (integer(int32)): A per-merchant override of the gateway-wide decryption budget, in milliseconds, or null to use the gateway setting. Conditional: When DecryptTimeoutMillisecondsOverride is not null. Range: 250 to 30000. (nullable)
**Content type:** `application/*+json`
Schema: [`MerchantPaymentEncryptionBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantPaymentEncryptionBinding.md)
Properties:
- `providerName` (string): Which payment encryption provider this entry binds the merchant to, by the provider's registered name. Compared case-insensitively. A null or blank provider is treated as no binding at all, so an incompletely boarded row cannot silently become a live selection. Required: When IsEnabled is true. (nullable, max length 64)
- `isEnabled` (boolean): Master enable flag for this provider on this merchant. When `false` or null, the selector must not return this binding even though the row exists. (nullable)
- `credentialSource` ([PaymentEncryptionCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionCredentialSource.md)): Whose provider account the decryption calls are billed to. Null reads as `Gateway`. (nullable)
Values:
- `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credentialSource reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
- `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[PaymentEncryptionBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionBindingFieldValue.md)>): The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Secret values are stored encrypted and are stripped, not decrypted, on every read that leaves the server. Only the server-side call to the provider ever uses the plaintext. Empty for a `Gateway` binding, whose values are filled in at read time from the host-scoped provider settings instead. A gateway-sourced row that carried values would be a copy of the gateway's credentials living on a merchant document. Conditional: When FieldValues is not null. (nullable)
Fields of each item:
- `key` (string): The provider setting name this value belongs to, matching a `PaymentEncryptionSettingFieldDefinition.SettingName` the provider's contributor declares. Compared case-insensitively. (nullable)
- `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and `null` on every read that leaves the server. (nullable)
- `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
- `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an empty one without the value ever being sent. (nullable)
- `keyEntries` (array<[PaymentEncryptionKeyEntry](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionKeyEntry.md)>): The key serial identifier entries that map an inbound key serial number to an HSM key. Conditional: When KeyEntries is not null. (nullable)
Fields of each item:
- `ksi` (string) required: The key serial identifier: six to ten significant hex characters, stored upper-case with leading `F` padding stripped. Unique within a binding. Conditional: When Ksi is not empty. (nullable)
- `label` (string): An operator-facing label for this key, such as the device family it was injected into. Shown wherever the key reference itself must not be. (nullable, max length 100)
- `scheme` ([PaymentEncryptionScheme](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionScheme.md)): Which encryption scheme the terminals under this key produce. Required: When Status != Deactivated. (nullable)
Values:
- `Dukpt`: Generic DUKPT (ANSI X9.24 data variant), TDES or AES.
- `OnGuard`: The Ingenico On-Guard protocol.
- `dukptMode` ([PaymentEncryptionDukptMode](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionDukptMode.md)): The DUKPT key derivation algorithm this key uses. (nullable)
Values:
- `Tdes`: Triple DES DUKPT (ANSI X9.24 Part 1).
- `Aes`: AES DUKPT (ANSI X9.24 Part 3). Carries a working-key type alongside it.
- `aesWorkingKeyType` (string): The AES working-key type, required when `dukptMode` is `Aes` and meaningless otherwise. A provider token value rather than an enum, because the vocabulary belongs to the vendor's command set. Required: When DukptMode == Aes. Conditional: When DukptMode is not null and DukptMode != Aes. (nullable, max length 16)
- `keyReference` (string): The HSM key reference: a storage-table slot or a wrapped key block. Always stored encrypted, and never returned on a read that leaves the server. (nullable, max length 1024)
- `isKeyReferenceConfigured` (boolean): Whether a key reference is stored, set on reads so an operator can tell a configured key from an empty one without the reference ever being sent. Server-owned: the save paths ignore whatever arrives here. (nullable)
- `majorKey` (string): The major key the reference is stored under, in the provider's own token vocabulary. Null leaves the provider's default in force. (nullable, max length 16)
- `onGuardExtendedEncryption` (boolean): On-Guard extended encryption, when the device family uses it. Meaningful only when `scheme` is `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. (nullable)
- `onGuardEndingPanDigitsEncrypted` (boolean): Whether the device family encrypts the ending PAN digits. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. (nullable)
- `onGuardClearPanDigits` (integer(int32)): How many leading PAN digits the device family leaves in the clear. Meaningful only for `OnGuard`. Conditional: When Scheme is not null and Scheme != OnGuard. Conditional: When OnGuardClearPanDigits is not null. Range: 0 to 6. (nullable)
- `status` ([PaymentEncryptionKeyEntryStatus](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionKeyEntryStatus.md)): Whether the entry may be matched. Null reads as `Deactivated`: an entry whose status nobody set has not been through the boarding step that activates it, and matching it would use a key the platform cannot confirm is live. (nullable)
Values:
- `Active`: The entry may be matched against an inbound key serial number.
- `Deactivated`: The entry is retired. It stays readable for explaining past transactions, and is never matched.
- `requireMac` (boolean): Reserved: whether the device family attaches a MAC that should be verified during decryption. (nullable)
- `createdAtUtc` (string(date-time)): When the entry was created, in UTC. (nullable)
- `statusChangedAtUtc` (string(date-time)): When `status` last changed, in UTC. Separate from the audit log because it is shown on the key table itself, where an operator decides whether a key is still in rotation. (nullable)
- `primaryEndpoint` (string): The primary provider endpoint for this merchant, or null to use the provider's own configured endpoint. HTTPS-only, enforced by the binding validator. Conditional: When PrimaryEndpoint is not empty. (nullable, max length 512)
- `secondaryEndpoint` (string): The secondary provider endpoint, used when the primary does not answer. HTTPS-only. Null when the merchant is bound to one region only. Conditional: When SecondaryEndpoint is not empty. Conditional: When SecondaryEndpoint is not empty and PrimaryEndpoint is empty. (nullable, max length 512)
- `decryptTimeoutMillisecondsOverride` (integer(int32)): A per-merchant override of the gateway-wide decryption budget, in milliseconds, or null to use the gateway setting. Conditional: When DecryptTimeoutMillisecondsOverride is not null. Range: 250 to 30000. (nullable)
## Responses
### 200
OK
**Content type:** `application/json`
Schema: [`PaymentEncryptionBindingConnectionTestResultDto`](https://devportal.demo.winkpg.io/docs/api/models/PaymentEncryptionBindingConnectionTestResultDto.md)
Properties:
- `succeeded` (boolean): Gets or sets whether the provider answered the probe.
- `reason` (string): Gets or sets a short explanation of the outcome, safe to show an operator. (nullable)
- `outcome` (string): Gets or sets the outcome as one word from a fixed vocabulary, so a caller can tell the cases apart without parsing `reason`: `Answered`, `DidNotAnswer`, `CredentialUnavailable` (the gateway could not load the credential the binding names, and the provider was never called), `NotProbeable`, `NotInstalled` or `NotEnabled`. (nullable)
- `steps` (array<[ConnectionTestStepDto](https://devportal.demo.winkpg.io/docs/api/models/ConnectionTestStepDto.md)>): Gets or sets the steps the test ran, in order. The platform always sends a list, empty when the test ran nothing; the published schema still marks it nullable, as it does every array, so a generated client should guard as it would any other. `succeeded` and `reason` are not derived from this list and keep their meaning for a caller that reads only them. (nullable)
Fields of each item:
- `name` (string): Gets or sets what the step checked, phrased for the operator. (nullable)
- `outcome` ([ConnectionTestStepOutcome](https://devportal.demo.winkpg.io/docs/api/models/ConnectionTestStepOutcome.md)): Gets or sets the verdict.
Values:
- `Passed`: The step ran and the thing it checks is good to go.
- `Failed`: The step ran and the thing it checks is not usable as configured.
- `Skipped`: The step did not run, because a gate is closed or an earlier step made it moot. The result says nothing about what it would have found.
- `Warning`: The step passed, and the detail is worth reading before trusting the configuration.
- `detail` (string): Gets or sets an optional second line, safe to show an operator: why a step was skipped, or what a failed one found. (nullable)
- `duration` (string(date-span)): Gets or sets how long the step took, when it was timed. Written as [-][d.]hh:mm:ss[.fffffff], for example 00:00:01.2500000; the seven-digit fraction of a second appears only when it is non-zero. Not an ISO 8601 duration. (nullable, pattern ^-?(\d{1,8}\.)?([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d{7})?$)
### 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 MerchantPaymentEncryptionBinding. See the Request body section below for its fields.
### cURL
```bash
curl -X POST "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/test-connection" \
-H "api-key: {{API_KEY}}" \
-H "Content-Type: application/json" \
-d '{
"providerName": "",
"isEnabled": false,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": false,
"isConfigured": false
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
}'
```
### PowerShell
```powershell
$headers = @{
'api-key' = '{{API_KEY}}'
}
$body = @'
{
"providerName": "",
"isEnabled": false,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": false,
"isConfigured": false
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
}
'@
$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/test-connection' `
-Headers $headers -ContentType 'application/json' -Body $body
```
### TypeScript (SDK)
```bash
npm install @winkpg/winkpg-api
```
```typescript
import { Configuration, MerchantPaymentEncryptionBindingApi } from '@winkpg/winkpg-api';
const api = new MerchantPaymentEncryptionBindingApi(new Configuration({
basePath: '{{BASE_URL}}',
apiKey: '{{API_KEY}}',
}));
const { data } = await api.merchantPaymentEncryptionBindingTestPaymentEncryptionBindingConnection("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", {
"providerName": "",
"isEnabled": false,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": false,
"isConfigured": false
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
});
```
### TypeScript (raw HTTP)
```typescript
const response = await fetch('{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/test-connection', {
method: 'POST',
headers: {
"api-key": "{{API_KEY}}",
"Content-Type": "application/json",
},
body: JSON.stringify({
"providerName": "",
"isEnabled": false,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": false,
"isConfigured": false
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
}),
});
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 MerchantPaymentEncryptionBindingApi(config);
var body = JsonSerializer.Deserialize("""
{
"providerName": "",
"isEnabled": false,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": false,
"isConfigured": false
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
}
""");
var result = await api.MerchantPaymentEncryptionBindingTestPaymentEncryptionBindingConnectionAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", 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}/payment-encryption-bindings/{providerName}/test-connection");
request.Headers.Add("api-key", "{{API_KEY}}");
request.Content = new StringContent("""
{
"providerName": "",
"isEnabled": false,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": false,
"isConfigured": false
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
}
""", 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.MerchantPaymentEncryptionBindingApi(client)
body = winkpg_api.MerchantPaymentEncryptionBinding.from_dict({
"providerName": "",
"isEnabled": False,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": False,
"isConfigured": False
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
})
result = api.merchant_payment_encryption_binding_test_payment_encryption_binding_connection("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", body)
```
### Python (raw HTTP)
```bash
pip install requests
```
```python
import requests
headers = {
"api-key": "{{API_KEY}}",
"Content-Type": "application/json",
}
body = {
"providerName": "",
"isEnabled": False,
"credentialSource": {},
"fieldValues": [
{
"key": "",
"value": "",
"isSecret": False,
"isConfigured": False
}
],
"keyEntries": [
{
"ksi": ""
}
],
"primaryEndpoint": "",
"secondaryEndpoint": "",
"decryptTimeoutMillisecondsOverride": 0
}
response = requests.request(
"POST",
"{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}/test-connection",
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.