billingHelp

Gateways (credential sets)

Adding your Stripe, PayPal, Square or Authorize.net keys, registering the webhook, verifying, and putting a set in service.

A credential set holds the keys of one provider account in one environment (test/sandbox or live/production). Settings → Gateways lists them. Owners add and change sets; admins can see them.

Where the platform offers it, you can also connect a Stripe, PayPal or Square account without copying keys: see Connecting your provider account. The rest of this page is about sets with your own keys.

Credential set (gateway) statuses A credential set starts as Draft. Verify makes one authenticated call to the provider; when it succeeds the set is Verified. Put in service needs the webhook value too and makes the set Test or Live, depending on its environment. A set can be disabled by hand, or automatically after three provider authentication failures in a row (the owners are emailed), and enabled again. Draft Verified Test or Live Disabled Verify Put in service (+ webhook value) enabledisable / 3 auth failures
Credential set (gateway) statuses
Text description

A credential set starts as Draft. Verify makes one authenticated call to the provider; when it succeeds the set is Verified. Put in service needs the webhook value too and makes the set Test or Live, depending on its environment. A set can be disabled by hand, or automatically after three provider authentication failures in a row (the owners are emailed), and enabled again.

Adding a set#

  1. Add credential set → choose the provider, the environment and a label (for example "Stripe live").
  2. Paste the keys. Each field says where to find the value at the provider. Secret values are stored sealed and shown afterwards as their last four characters only.
  3. On the set's page, copy the Webhook endpoint URL and register it at the provider with the events listed under Events to send.
  4. Paste the provider's webhook value (Stripe: signing secret; PayPal: webhook ID; Square: signature key; Authorize.net: signature key).
  5. Verify credentials makes one authenticated call to the provider.
  6. Put in service (Test) or (Live). The set can now be chosen on products.

The step-by-step guides for each provider start from creating the provider account: Stripe, PayPal, Square, Authorize.net.

Rules worth knowing#

  • Changing any value returns the set to Draft until it is verified again. Products using it stop offering it meanwhile.
  • Three provider authentication failures in a row disable the set and email the owners. Fix the keys, then Re-enable as Draft, verify and put it back in service.
  • The environment is checked against the keys: a live key in a test set is refused.
  • Managed by the platform sets were added by the platform operator. You can use them on products but not change them.

Testing the webhook#

The set's page shows Last check and the signature check. After a test payment, the payment page shows the provider's events under History. If a payment stays Pending after the buyer paid, the webhook is not arriving: see Troubleshooting payments.