SubscriptionFlow lets you integrate with Peach Payments, one of the most popular gateways in the South African region. This guide shows you how to integrate, configure and use Peach Payments to collect payments.
- Enter Administration Settings from your admin dashboard by clicking the gear icon in the top right.
- Then click on “Payment Gateways” under Billing.
- Here you can see all your installed and active payment gateways. Click on “+ Payment Gateway”.
- Select Peach Payments.
- Inside the integration widget you need to enter 6 different access granting credentials available from your Peach Payments account.
- Log into your Peach payments account and click on “Checkout”.
- Here you can find your hosted checkout entity key and secret token, your embedded checkout client ID and client secret, and your merchant ID.
- Copy and paste all 5 of these access granting credentials into the relevant fields inside the SubscriptionFlow integration widget.
- Then go back to your Peach Payments account and click on “Recurring Payments” to retrieve your recurring access token. Then copy and paste it into SubscriptionFlow.
- Check the sandbox if applicable and test your connection. Then save this gateway.
- Your payment gateway is now installed and active. It can be uninstalled easily using the “Uninstall” button on top if needed.
- Under Advanced Options, configure this newly connected payment gateway. Check the default payment methods box to auto-enable whichever payment methods you have selected to collect payments inside your Peach Payments accounts. Check Make Default to set this gateway as your default for collecting payments.
- Choose who you wish to grant permission to make changes to this configuration.
- Enable payment method validation and public payment method page to allow customers to add a payment method and validate it through a 1 ZAR reversible transaction.
- Now enter the customer module and select a customer.
- Scroll down and click on “Payment Methods”.
- This is where you can find the “Public Payment Method Page”.
- This public page lets your customer add a payment method to their account. Click proceed.
- The pop up will ask you to add your VISA/Mastercard details for a 1 ZAR validation transaction. This one time validation will allow you to process payments on this card without the need for authorization in the future.
- Go to your Peach Payments account to see this 1 ZAR transaction and its reversal.
-
The checkout flow creates a subscription and an invoice inside SubscriptionFlow and a payment is completed by the customer after the fact. However, if checkout is abandoned, the subscription and invoice created at the time of checkout will clutter the system needlessly. For this reason, check Payment Abandoned.
-
The Payment Abandoned checkout enables you to set a time period. If a payment is not completed during this period, the subscription and invoice is trashed by virtue of being abandoned. Check the Delete Subscription & Invoice action if no payment data made available at the end of the selected time period.
- Use the webhook URL to relay payment status information between the two systems. However, for order placement followed by invoice clearance or recurring payments you need a webhook to update the status of your payments inside SubscriptionFlow when their status changes within Peach Payments.
- Go to your Peach Payments account and click on “Payment Links”.
- Then navigate to “Settings” to find your webhook URL field.
- Copy the webhook URL inside the integration widget and paste it into the Webhooks field inside Peach Payments.
- Next, you will need to verify this webhook. Click verify and go back to SubscriptionFlow to find the code required for verification.
- Refresh your page if needed and retrieve the verification code.
- Enter the code to change the status of the webhook to verified.
- Save changes.
Whitelist the SF Domain for Checkout
- Inside Peach Payments click on the Checkout tab. Scroll down to Allowlisted domains and click on +Add domain.
- Enter your SubscriptionFlow domain name i.e. abc.subscriptionflow.com. In case you are using domain mapping use abc.com. Click Add.
- Your domain is now pending approval in the allowlisted domains. These are the domains that your checkout store has permitted. Once approved your checkout will flow seamlessly.
Comments
0 comments
Please sign in to leave a comment.