Enable the pre-payment webhook

Steps

In the new admin:

1. 1

   Go to Settings → Payments.

2. 2

   Select the payment method set you want to configure (most stores have only one, the Default).

3. 3

   In the Fraud protections section, find Pre-checkout webhook and click it to configure.

In the legacy admin:

1. 1

   Go to the payment setting page in your store’s administration.

2. 2

   Ensure you’ve selected the payment set you want to enable the hook for.

3. 3

   In the Anti-Fraud Integrations section, check enable custom pre-payment hook.

4. 4

   Complete the settings below it (see the fields below).

Settings

Pre-payment hook URL
The URL for the endpoint script, which must be HTTPS, that will receive the JSON payload.

Failure handling
If your endpoint script fails to load or respond correctly, this setting controls whether the transaction is automatically approved or rejected. If set to reject, a generic error message is returned — you can edit that message from the “language” section of your store’s administration, under the “checkout” group, looking for the “error precheckout hook” language string.

Notes

• Requests to your webhook endpoint also include several special headers:

• The pre-payment webhook is primarily triggered right before payment is sent to your gateway (validation/payment). For some gateways, it’s also triggered prior to a 3DSv2 challenge (validation/3ds) — these triggers are documented on the respective gateway wiki pages (Opayo, Barclaycard).