Setup
You will need to set up an account with Stripe, and obtain a publishable key and a secret key.
Parameters
In HB CRM Integration Parameters, set the following Stripe parameters:
Parameter | Description | Settings |
STRIUSE | Stripe payment processing in use? | Set to Y if you are using Stripe to process debit / credit card transactions. |
STRIPKEY | Stripe API publishable key | The Stripe API publishable key you have configured in Stripe. |
STRISKEY | Stripe API secret key | The Stripe API secret key you have configured in Stripe. |
STRIBANK | Default bank code for Stripe transactions | Enter the default cash book bank code to be used for Stripe transactions. |
STRITXNT | Cash book transaction type for Stripe receipts | The cash book transaction type for Stripe payments that customers have made. |
STRIEVSA | Plot sales cash event code | The event type to be created in the sales workbench history when a Stripe transaction is processed. |
STRIEVPR | Pre-release reservation cash event code | The event type to be created in the provisional reservation workbench history when a Stripe transaction is processed. |
STRIEVCA | Cancellations workbench cash event code | The event type to be created in the cancellation workbench history when a Stripe transaction is processed. |
STRIPAYM | Cash event payment method for Stripe transactions | The payment method to use on cash events created by the Stripe processing. |
Transaction Categories
Specify the transaction categories that you want to use for card transactions. Set up one category each for reservation deposit and customer choices.
In Maintain Transaction Categories, while updating a category record, tick the Valid for Debit/Credit Card Transactions box, and choose the Card Transaction Type (reservation deposit or customer choices).
Schedule the Update Incomplete Stripe Transactions Report
Update Incomplete Stripe Transactions is a report that can update the status of incomplete Stripe credit card or debit card transactions. Incomplete transactions can occur if the user does not wait for the payment success page to be shown or a loss of network connection occurred after completing the Stripe payment page.
Schedule the report to run at regular intervals.
For each incomplete transaction, a call will be made to Stripe to check the processing status of the transaction. If the Stripe status is ‘cancelled’ or ‘succeeded’, the COINS transaction will be updated with the new status.
📌Note: Incomplete Stripe checkout sessions are automatically cancelled after 24 hours.
Taking Card Payments Using Stripe
⚠️Important: Card details are captured on a payment page hosted by Stripe; no card data is passed to, collected or stored on the Coins ERP+ server.
Once Coins ERP+ is configured to use Stripe, a credit card button is shown in the context area of a reserved plot on the Plot Summary of the Sales Workbench or Provisional Reservation Workbench.
On the Plot Summary, click the
button.Coins ERP+ displays the Customer Payment screen.
Select which of the purchasers on the plot is making the payment.
In the Payment Breakdown frame, tick the box or boxes next to the items that the payment covers.
For each item you ticked, select the appropriate Category.
Click the
button.Enter the credit or debit card details and click the Pay button.
After all the required details are entered and submitted, Stripe will attempt to authorise the payment with the bank. If the payment is successful:
Coins ERP+ displays a confirmation.
A cash event record is created in the sales workbench history for the plot. This uses the cash event code specified in the Interface parameter STRIEVS.
If the payment fails, any errors are shown on the Stripe checkout page.
Refunds
To refund all or part of a payment made using Stripe, you need to select the original credit card transaction to be refunded.
To process a refund
In the Sales Workbench, Provisional Reservation Workbench or Cancellation Workbench, open the plot record for which the payment was made.
Click the
button. Coins ERP+ displays the Customer Payment screen.
On the Customer Refund tab, click the
button for the payment you want to refund.
For a partial refund, enter the amount (or amounts) to refund.
Click
.If the refund is successful, Coins ERP+ displays a confirmation.
Reviewing and Posting
The Credit/Debit Card Workbench in Cash Book allows you to review credit card or debit card payments processed by Stripe, to ensure transactions have been coded correctly. When the transactions have been reviewed, you can create a cash book batch.
To review transactions
If the analysis is correct:
In the Credit/Debit Card Workbench, select the transaction (you can select more than one at once using the shift or control keys on your keyboard).
Choose the Set as Reviewed action and click Apply Action (
).
If the analysis is incorrect:
In the Credit/Debit Card Workbench, open the transaction.
Choose the correct Category.
Change the Status to Reviewed.
To bulk update a set of transactions to ‘Reviewed’
From the Options menu of the Credit/Debit Card Workbench, choose Set as Reviewed.
In the Set as Reviewed screen, enter the range of dates for the transactions and click Next (
).All transactions in this date range will be set to a status of Reviewed.
To create a Cash Book batch
From the Options menu of the Credit/Debit Card Workbench, choose Create Cash Book Batch.
Choose the financial period for the Cash Book batch.
If you want to automatically post the batch, tick the Post Cash Book Batch box.
The transaction type for the Cash Book transactions is taken from the interface parameter STRITXNT.
If you did not choose to post the batch automatically, post the batch in the usual way.