Windcave
On this page
Supported features
- Standard checkout
Payment provider configuration options
To generate your API Key and Secret values, follow these instructions from Windcave: REST Guide
| StoreConnect Field | Usage |
|---|---|
| Provider | Picklist Value API Name = Windcave |
| API Mode | sandbox / production |
| API Key | API Username |
| API Secret | API Key |
| API Options |
Test and live environments
The API Mode value sets which Windcave environment receives checkout, card-on-file, and refund requests:
| API Mode | Windcave environment |
|---|---|
production or live |
Live (sec.windcave.com) |
sandbox, or any other value |
Test, also called UAT (uat.windcave.com) |
The value is not case-sensitive, so Production also uses the live environment. Use an API Key and API Secret from the same Windcave environment as the API Mode. Windcave rejects credentials from the other environment, and checkout fails with an authentication error.
:::warning
Test credentials do not work with API Mode set to production. If you are still testing and have no live credentials yet, set API Mode to sandbox.
:::
A refund goes to the environment that the current API Mode selects. If an order was paid on the test environment, you cannot refund it after you switch the provider to the live environment, because no real payment exists.
Troubleshoot a failed checkout
If Windcave rejects the request to start a payment, the customer stays on the payment step and sees an error message. The Pay Now button is available again, so the customer can retry once you fix the cause.
| Cause | Message the customer sees (default English text) |
|---|---|
Windcave rejects the API Key and API Secret (HTTP status 401) |
Error authorizing with API |
| Windcave rejects the request for any other reason | We were unable to verify your payment! |
| The request fails before Windcave answers, for example a network error | Sorry, an error occurred while trying to process the payment. Please try again later. |
The customer never sees the detail from Windcave. To find the reason, open the web console on your store and go through checkout with Windcave. Then select the payment_sessions#create entry. The RESPONSE line for the sessions_create call shows the HTTP status and the response body from Windcave, for example WindcaveRest::ApiError status=401 body={"errors":[...]}.
A 401 status usually means the credentials don’t match the API Mode. Check that the API Key and API Secret come from the Windcave environment that the API Mode selects (see Test and live environments).
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.