Difference between revisions of "SlimPay"

Revision as of 09:41, 4 April 2017

SlimPay is a Direct Debit payment gateway supporting both BACS Direct Debit for UK based customers and SEPA for EU based customers.

What is Direct Debit?

Direct Debit is a pull-based bank-to-bank payment method: a customer authorises a merchant to automatically debit their bank account of the amount of the subscription.

Payment workflow

The first time a user pays an invoice using the SlimPay payment gateway, they will be asked to complete a mandate that authorizes you (the merchant) to debit their bank account automatically each subscription cycle. The customer only has to do this once.

Upon creation of a mandate for the first time, a payment request will be initiated. Until such time as the payment has fully completed, the invoice will display a "Payment Pending" status and display a message to the user as shown below. No automated provisioning actions will be performed until the payment has fully cleared, unless you enable the Instant Activation for New Orders option.

Direct debit is not an instant payment service. Payments can take up to a few days to clear and fully complete processing.

For recurring invoices where a mandate agreement already exists between you and the customer, WHMCS will automatically request a payment capture on the due date of the invoice.

Supported Currencies

SlimPay supports payments in Euro and British Pounds. The module will automatically select the appropriate BACS or SEPA payment method based on the currency of the invoice.

Activation

Navigate to Setup > Payments > Payment Gateways. Select the All Payment Gateways tab. Now click the SlimPay button to activate it.

You will be prompted for your SlimPay App ID, Secret and Creditor Reference which should have been provided to you by SlimPay.

Instant Activation for New Orders

Direct debit is not an instant payment service. Payments can take up to a few days to clear and fully complete processing.

If you wish to provision new orders immediately upon the completion of a mandate agreement and initiating of a payment, to avoid the customer having to wait while the payment clears, you can check the "Instant Activation for New Orders" option in the SlimPay payment gateway settings and this will trigger the invoice to be marked paid and any successful payment automation actions to be carried out immediately.

Rejected Payments

The SEPA scheme allows an eight week period where a payment received can be rejected or reversed by the payee. WHMCS will monitor for any changes in the payment status of invoices paid via SlimPay during this time and will automatically process these as appropriate.

To learn more, visit Payment Reversals

Sandbox

SlimPay have a sandbox for testing the payment integration. You can apply for sandbox credentials here: https://dev.slimpay.com/hapi/login?signup

@@ Line 1: / Line 1: @@
-==Setup==
+SlimPay is a Direct Debit payment gateway supporting both BACS Direct Debit for UK based customers and SEPA for EU based customers.
-[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]
+==What is Direct Debit?==
+Direct Debit is a pull-based bank-to-bank payment method: a customer authorises a merchant to automatically debit their bank account of the amount of the subscription.
+==Payment workflow==
+The first time a user pays an invoice using the SlimPay payment gateway, they will be asked to complete a mandate that authorizes you (the merchant) to debit their bank account automatically each subscription cycle. The customer only has to do this once.
+[[File:Slimpay-mandate-success.png|center]]
+Upon creation of a mandate for the first time, a payment request will be initiated. Until such time as the payment has fully completed, the invoice will display a "Payment Pending" status and display a message to the user as shown below. No automated provisioning actions will be performed until the payment has fully cleared, unless you enable the Instant Activation for New Orders option.
+<div class="docs-alert-warning">Direct debit is not an instant payment service. Payments can take up to a few days to clear and fully complete processing.</div>
+[[File:Slimpay-invoice.png|center]]
+For recurring invoices where a mandate agreement already exists between you and the customer, WHMCS will automatically request a payment capture on the due date of the invoice.
+==Supported Currencies==
+SlimPay supports payments in Euro and British Pounds. The module will automatically select the appropriate BACS or SEPA payment method based on the currency of the invoice.
+==Activation==
+Navigate to Setup > Payments > Payment Gateways.  Select the All Payment Gateways tab. Now click the SlimPay button to activate it.
-Begin by activating the payment gateway under '''Setup > Payments > Payment Gateways''' and choose SlimPay from the All Payment Gateways tab.
+You will be prompted for your SlimPay App ID, Secret and Creditor Reference which should have been provided to you by SlimPay.
-Once activated, you can then enter the configuration details received from SlimPay.
+[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]
-===Sandbox===
+==Instant Activation for New Orders==
-SlimPay have a sandbox for testing the payment integration. You can apply for sandbox credentials here: https://dev.slimpay.com/hapi/login?signup
+Direct debit is not an instant payment service. Payments can take up to a few days to clear and fully complete processing.
-===Instant Activation for New Orders===
+If you wish to provision new orders immediately upon the completion of a mandate agreement and initiating of a payment, to avoid the customer having to wait while the payment clears, you can check the "Instant Activation for New Orders" option in the SlimPay payment gateway settings and this will trigger the invoice to be marked paid and any successful payment automation actions to be carried out immediately.
-Payments received using the SlimPay module will take time to be processed and recevied. Enabling the "Instant Activation for New Orders" option will allow a payment that is pending for a new mandate signup to be seen as being completed immediately. This will allow automation immediately on payment signup.
+==Rejected Payments==
-===Supported Currencies===
+The SEPA scheme allows an eight week period where a payment received can be rejected or reversed by the payee. WHMCS will monitor for any changes in the payment status of invoices paid via SlimPay during this time and will automatically process these as appropriate.
-Slimpay support using EUR for SEPA payments, and GBP for BACS payments. The module automatically chooses the correct scheme based on the client currency. It is not possible to use the Convert To option when using SlimPay.
-==Recurring Payments==
+To learn more, visit [[Payment Reversals]]
-Once a mandate is created and associated with the client account, it can be used for automatic recurring payments (like a Credit Card Module).
+==Sandbox==
-===Rejected Payments===
+SlimPay have a sandbox for testing the payment integration. You can apply for sandbox credentials here: https://dev.slimpay.com/hapi/login?signup
-The SEPA scheme allows an eight week period where a payment received can be rejected by the payee. As such, new functionality has been introduced to reverse a payment in WHMCS that will set the invoice state automatically to collections. In additional to changing the invoice, the due date of any service and addon will be reversed automatically.

Documentation