Clientexec GoCardless Gateway Plugin Documentation

Setting Up the Payment Gateway

 September 19, 2018     0 Comments

The install script will set up most of these options, but here are an explanation of the important options.

Payment Plugins Screen

The plugin is under the name of "GoCardless Pro (Basic)", here's a brief outline of each option:

Default:  Self explanatory;

In Signup: Choose whether the gateway is allowed to be chosen by the client on the order form;

Plugin Active: When this is set to 'Yes', the plugin will fire off payments to GoCardless automatically;

Language (beta): This is the language the interface will use. Only English at the moment, although, you can edit the file to your liking. Also, the client side is in English and is not currently changable;

Days After Invoice Generation (beta): This setting allows you to determine when you wish to request payment from client's bank nn days after the invoice generation date. Helpful if you wish to give clients ample time to pay by other methods first...Note 1: Payments take about 3 working days to be processed. Note 2: Please take your Invoice Offset into account when choosing;

Send Admin Emails: This will send everything that the plugin does, send payments, errors, etc, to the default admin account (ID 100). This will change to include every Admin account in future;

Send Prowl Notifications: Same as the above but to the app. Note: The Prowl plugin needs to be active for this option to work;

BCC Email Address for Admin Emails: Optional;

Send Client Emails: This will send emails to the client when, a direct debit is created, fails ,gets cancelled and expires. It will also send emails when a payment fails;

Failed Payment Template Subject (optional): Here you supply the Subject for failed payments to clients, if the main Template is blank, the default template subject. You can use the same tags as for the main template.

Failed Payment Template (optional): 

Here you supply the layout for failed payments to clients, if this is blank, the default template will be used. Tags you can use are: [CLIENTID], [ORGANIZATION], [CLIENTNAME], [CLIENTFIRSTNAME], [CLIENTLASTNAME], [CLIENTEMAIL], [INVOICEID], [PAYMENTID], [CURRENCY], [PAYMENTAMOUNT], [FAILUREREASON], [CLIENTEXECURL], [COMPANYNAME];

Failed Auth Setup Template Subject (optional): Like the above. Here you supply the Subject for failed Direct Debits Setup to clients, if the main Template is blank, the default template subject. You can use the same tags as for the main template;

Failed Auth Setup Template (optional): Like the above. Here you supply the layout for failed payments to clients, if this is blank, the default template will be used. Tags are: [CLIENTID], [ORGANIZATION], [CLIENTNAME], [CLIENTFIRSTNAME], [CLIENTLASTNAME], [CLIENTEMAIL], [MANDATEID], [FAILURECAUSE], [FAILUREREASON], [CLIENTEXECURL], [COMPANYNAME];

Pay First Invoice: If you want to send the very first invoice to GoCardless, set this to YES. Note: To prevent fraud, I personally decided clients need to pay by another method (NO).

Pay Cancelled Packages: If you want your clients to pay for cancelled package when there are unpaid invoices, choose YES;

Pay New Domain Orders: If you want your clients to pay for new domain orders by direct debit, choose YES. Note: If a domain is in the same invoice as any other package, it will not be processed when this is set to NO. You'll need to split the invoice

Production API Token *: Production Token used to identify you to GoCardless' Pro API. (needs to be set);

Production Secret ID *: Production Secret ID used to identify you to GoCardless' Pro API. (needs to be set);

Production Creditor ID optional): This will start with a CR. You might need to add a creditor manually. This has to be enabled on your account by GoCardless.



How helpful was this article to you?

Powered by
FraudLabs Pro Prevents Fraud for Digital Businesses