Card payments
The merchant needs to provide details mentioned below so we can register the webhook in the BIP, we will provide a decryption key once the webhook is configured. See this guide for more details.
- Technical email address (optional and only possible in the BIP)
- Webhooks URL (must be HTTPS in LIVE)
- Payment types to receive notifications for (eg. Debits, refunds etc)
- Indicate your preference for JSON wrapped notifications or plain text
Some additional notes on webhook integration:
- Upon receiving the notification to your webhook url the system will expect an HTTP 200 response.
- Only webhooks sitting on port 80 and port 443 are guaranteed to work
- In order to register the webhook, we send a test notification to see if the webhook is configured correctly on your side. If either one of the first two points above is not satisfied, registration will fail.
- The test notification is a 206 character HTTP Post (Content-Length=206)
- We require that you test the webhook in the TEST system before configuring it for LIVE.
Encryption
| Parmeter | Description |
|---|---|
| Encryption algorithm | AES |
| Key | [secret of listener] (64-character-long hexadecimal string in configuration) |
| Key length | 256 bits (32 bytes) |
| Block mode | GCM |
| Padding | None |
| Initialization vector | In HTTP header (X-Initialization-Vector) |
| Authentication tag | In HTTP header (X-Authentication-Tag) |
Payments API
The merchant needs to provide details mentioned below so we can register the webhook in the Peach payment console under the development Tab (reference Figure.1 below), we will provide a decryption key once the webhook is configured. For more details refer to any of the switch PDF guides
- Webhooks URL (must be HTTPS in LIVE)
- Indicate your preference for JSON wrapped notifications or plain text
Figure.1. Webhook Under Development Tab
Encryption
| Parmeter | Description |
|---|---|
| Encryption algorithm | AES |
| Key | [secret of listener] (32-character-long hexadecimal string in configuration) |
| Key length | 128 bits (16 bytes) |
| Block mode | GCM |
| Padding | None |
| Initialization vector | In HTTP header (X-Initialization-Vector) |
| Authentication tag | In HTTP header (X-Authentication-Tag) |
Woocommerce
A webhook acts as a failsafe just in case there are any interruptions during a payment process. The webhook will ensure the merchant's WooCommerce store/Dashboard always receives a correct transaction status. (The webhook will instantly send a notification to the WooCommerce dashboard every time the peach console receives a transaction).
We will need the merchant's website URL to configure the webhook
1. Webhook configuration format for the Checkout Hosted page (Card/EFT/Masterpass/Mobicred):
<merchant-store-url>/?wc-api=wc_switch_webhook_peach_payments
Example: https://www.peachpayments.com/?wc-api=wc_switch_webhook_peach_payments)
- This needs to be configured in the console under the Checkout Tab (reference Figure.2. Below)
- The Webhook URL caters for the Checkout Hosted Page (screenshot below)
Figure.2. Webhook Under checkout Tab
2. Webhook configuration format for the standalone Card option on the Peach payment plugin:
<merchant-store-url>/?wc-api=wc_payon_webhook_peach_payments
Example: https://www.peachpayments.com/?wc-api=wc_payon_webhook_peach_payments
- This can be configured in the BIP (reference Figure.3. Below)
- Provide a decryption key to the merchant
- The Webhook URL caters for the Copy and Pay payment form on the WC peach pay plugin (screenshot below)
Figure.3. Webhook In the BIP
Magento
A webhook acts as a failsafe just in case there are any interruptions during a payment process. The webhook will ensure the merchant's Magento store/Dashboard always receives a correct transaction status. (The webhook will instantly send a notification to the Magento store every time the peach console receives a transaction).
https://{MAGENTO_BASE_URL}/pp-hosted/secure/webhook
Example: https://www.peachpayments.com/pp-hosted/secure/webhook
- This needs to be configured in the console under the Checkout Tab (reference Figure 2. above)
OpenCart
A webhook acts as a failsafe just in case there are any interruptions during a payment process. The webhook will ensure the merchant's OpenCart store/Dashboard always receives a correct transaction status. (The webhook will instantly send a notification to the WooCommerce dashboard every time the peach console receives a transaction).
https://{OpenCart_BASE_URL}/index.php?route=extension/payment/peach_payments/callback
Example: https://www.peachpayments.com/index.php?route=extension/payment/peach_payments/callback
- This needs to be configured in the console under the Checkout Tab (reference Figure 2. above)
nopCommerce
A webhook acts as a failsafe just in case there are any interruptions during a payment process. The webhook will ensure the merchant's nopCommerce store/Dashboard always receives a correct transaction status. (The webhook will instantly send a notification to the WooCommerce dashboard every time the peach console receives a transaction).
https://{nopCommerce_BASE_URL}/Plugins/PeachPayments/Callback
Example: https://www.peachpayments.com/Plugins/PeachPayments/Callback
- This needs to be configured in the console under the Checkout Tab (reference Figure 2. above)
Custom Checkout (Hosted Payment Page)
The merchant needs to provide details mentioned below, so we can register the webhook in the Peach payment console under the Checkout Tab (reference Figure.2 above), a decryption key will not be required. For more details, refer to Custom Checkout (Hosted Payments Page) guide
- Webhooks URL (must be HTTPS in LIVE)
Paysafe
Refer to this document: https://www.peachpayments.com/developers/paysafe
Or the webhook can be added to the BIP - similar to Card Payments