Difference between revisions of "Stripe Security Deposit capture"

From Beds24 Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:How to]]
 
[[Category:How to]]
 
[[Category:Payments]]
 
[[Category:Payments]]
 +
 
<div class="heading">Stripe - Authorise a Refundable Security Payment</div>
 
<div class="heading">Stripe - Authorise a Refundable Security Payment</div>
  
−
  This page is about the menu {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT GATEWAYS > STRIPE and authorisation of a refundable payment.
+
  This page is about the menu {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT GATEWAYS > STRIPE and authorisation of a refundable payment and explains how to setup a pending payment to ‘Capture/Authorise’ a refundable Security Deposit.  
−
 
 
−
This page explains how to setup a pending payment to ‘Capture/Authorise’ a refundable Security Deposit.  
 
  
 
__TOC__
 
__TOC__
Line 22: Line 21:
 
=How it works=
 
=How it works=
  
−
Stripe and you can authorise a payment on a credit card to be released after a fixed period if the payment is not collected.  
+
With Stripe you can authorise a payment on a credit card to be released after a fixed period if the payment is not collected.  
 
You can define the Due date/time and the amount to be authorised.
 
You can define the Due date/time and the amount to be authorised.
  
 
=Set up=
 
=Set up=
−
==='''Step 1:'''  Setup Stripe Account ===
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
Step 1: Setup Stripe Account
 +
</div>
 +
<div class="mw-collapsible-content">
  
 
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT GATEWAYS > STRIPE and set:
 
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT GATEWAYS > STRIPE and set:
Line 39: Line 42:
 
*'''Title''' - Customise the title for this payment option.
 
*'''Title''' - Customise the title for this payment option.
 
*'''Instruction''' - Create an optional description to appear next to the Stripe pay now button.
 
*'''Instruction''' - Create an optional description to appear next to the Stripe pay now button.
 +
</div></div>
  
−
==='''Step 2:''' Create a Payment Rule - Capture Refundable Security Deposit ===
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
Step 2: Create a Payment Rule - Capture Refundable Security Deposit
 +
</div>
 +
<div class="mw-collapsible-content">
  
 
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
 
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
Line 56: Line 64:
 
*All Booking Info Codes (optional)
 
*All Booking Info Codes (optional)
 
*Exclude Booking Info Code= BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT If you have virtual credit cards from the channels, then use this option.   
 
*Exclude Booking Info Code= BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT If you have virtual credit cards from the channels, then use this option.   
−
  You will need to send a payment request link to the guest for them to authorise the payment as it is not possible to authorise a refundable payment on a Virtual Card.
+
 
−
Payment Limit: (optional)
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> You will need to send a payment request link to the guest for them to authorise the payment as it is not possible to authorise a refundable payment on a Virtual Card.
−
*Booking Balance or Group Booking Balance
+
 
−
This can be used to prevent accidental overcharging in case a payment has already been made.
 
 
Payment Action :
 
Payment Action :
 +
*Funding Source = Guest card only
 +
*Payment value adjustment = Default
 
*Capture = NO - Authorised for collection later
 
*Capture = NO - Authorised for collection later
 
*Add info code on success = add a Booking Info item to the booking on success
 
*Add info code on success = add a Booking Info item to the booking on success
 
*Add info code on failure = add a Booking Info item to the booking on failure
 
*Add info code on failure = add a Booking Info item to the booking on failure
 +
 
Prevent Auto Payment :
 
Prevent Auto Payment :
 
*Prevent payment if booking status : Cancelled
 
*Prevent payment if booking status : Cancelled
 +
*Prevent payment after check-out (days) = 7 (default)
 
*Prevent payment action : Set Manual
 
*Prevent payment action : Set Manual
 +
</div></div>
  
−
==='''Step 3:''' Create Auto Auctions===
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
Step 3: Create Auto Actions
 +
</div>
 +
<div class="mw-collapsible-content">
  
−
Go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT > AUTO ACTIONS
+
Go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT > AUTO ACTIONS and click '''Create New Action''' to create them.
 
   
 
   
−
If the guest credit card is already at Stripe.
+
If the guest credit card is already at Stripe.
 
   
 
   
−
<div class="mw-collapsible mw-collapsed">
+
'''Auto Action 1 - Authorise payment for all bookings - Guest Credit card at Stripe'''
−
<div class="headline-collapse" >
 
−
==== Auto Action 1 - Authorise payment for all bookings - Guest Credit card at Stripe ====
 
  
 
For bookings via your booking page (direct) and Channel bookings (non virtual cards), the credit card has been sent and stored at Stripe.  
 
For bookings via your booking page (direct) and Channel bookings (non virtual cards), the credit card has been sent and stored at Stripe.  
−
 
−
</div>
 
−
<div class="mw-collapsible-content">
 
−
Click '''Create New Action'''
 
  
 
Trigger tab:
 
Trigger tab:
Line 90: Line 100:
 
**Time Window = 1 day  
 
**Time Window = 1 day  
 
*Booking Source
 
*Booking Source
−
**Booking Source =ALL (this will apply to all bookings)
+
**Booking Source =All (this will apply to all bookings, direct, manual and channels). If you want to have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings. 
−
If you want to have different auto actions/rules for each channel booking, then select the Channel from the list’
 
−
 
 
  
 
*Booking Conditions
 
*Booking Conditions
Line 100: Line 108:
 
*Info Codes
 
*Info Codes
 
**Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT
 
**Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT
−
If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.
 
  
 +
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.
  
 
Booking tab: Optional
 
Booking tab: Optional
 
*Flag Text = Security Deposit Pending Payment (for example)
 
*Flag Text = Security Deposit Pending Payment (for example)
 
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
−
 
  
 
Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.
 
Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.
Line 112: Line 119:
 
*Booking Info Text - Refundable Security Deposit pending payment
 
*Booking Info Text - Refundable Security Deposit pending payment
 
   
 
   
−
 
 
Invoice tab:
 
Invoice tab:
 
*Add a Pending Payment to the booking
 
*Add a Pending Payment to the booking
Line 123: Line 129:
 
**Payment time = set the time to collect payment
 
**Payment time = set the time to collect payment
 
**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
 
**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
−
</div>
 
−
</div>
 
  
−
If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.
 +
 
  
−
<div class="mw-collapsible mw-collapsed">
+
'''Auto Action 2 - Send Payment Request with link for Security Deposit Authorisation'''
−
<div  class="headline-collapse" >
 
−
====Auto Action 2 - Send Payment Request with link for Security Deposit Authorisation====
 
  
 
Can be used for channel bookings with virtual cards or properties/guests in EU countries and required to comply with EU 3DSecure regulations.  
 
Can be used for channel bookings with virtual cards or properties/guests in EU countries and required to comply with EU 3DSecure regulations.  
−
 
−
</div>
 
−
<div class="mw-collapsible-content">
 
−
 
−
Click '''Create New Action'''
 
  
 
Trigger tab:
 
Trigger tab:
Line 146: Line 144:
  
 
*Booking Source
 
*Booking Source
−
**Booking Source =ALL (this will apply to all bookings)
+
**Booking Source =All (this will apply to all bookings, direct, manual and channels). If you want to have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
−
If you want to have different auto actions/rules for each channel booking, then select the Channel from the list’
 
  
 
*Booking Conditions
 
*Booking Conditions
Line 153: Line 150:
 
**Status = All not cancelled
 
**Status = All not cancelled
 
**Invoice Balance= Any  
 
**Invoice Balance= Any  
−
 
−
*Info Codes
 
−
**Exclude Booking Info code = STRIPEAUTHORISE CARDTOSTRIPE
 
−
This will trigger for all bookings that do not have a valid card at Stripe.
 
  
 
Message tab:
 
Message tab:
Line 214: Line 207:
 
Booking Info tab: Optional, for information and reporting
 
Booking Info tab: Optional, for information and reporting
 
*Booking Info Code = PAYREQ (for example enter the value - use one word only)
 
*Booking Info Code = PAYREQ (for example enter the value - use one word only)
−
*Booking Info Text = Enter the description/text to show in for the Booking Info Code.  
+
*Booking Info Text = Enter the description/text to show in for the Booking Info Code.
 +
 
 +
</div></div>
 +
 
 +
=Credit Card details at Stripe=
 +
 
 +
The card will be saved as a new customer in Stripe with the booking number as a reference. Once the new customer is created in Stripe the card can be charged.
 +
 
 +
Multiple cards can be sent for each Stripe customer and a specific one selected when charging.
 +
 
 +
Stripe will only accept valid cards. If Stripe reject the card, it's details will still be visible at Beds24.
 +
 
 +
Info Codes in the "Info" tab of the booking show you which action was performed.
 +
 
 +
{| class="wikitable"
 +
! scope="col"| Code
 +
! scope="col"| Use
 +
|-
 +
 
 +
|CARDTOSTRIPE
 +
| card details were sent to Stripe
 +
|-
 +
 
 +
|STRIPEPAYMENT
 +
| payment imported from Stripe
 +
|-
 +
 
 +
|STRIPEFAIL
 +
| card could not be sent to Stripe
 +
|-
 +
 
 +
|CARDEXPIRES
 +
| added when the card expires before check-in
 +
|-
 +
 
 +
|STRIPEAUTHORIZE
 +
| payment has been authorised by Stripe
 +
|-
 +
 
 +
|STRIPEREFUND
 +
| refund has been processed at Stripe
 +
|-
 +
 
 +
|CARDFAILSTRIPE
 +
| card has failed at Stripe, see the note for reason
 +
|-
 +
 
  
−
</div>
+
|}
−
</div>
 

Latest revision as of 08:59, 29 July 2024


Stripe - Authorise a Refundable Security Payment
This page is about the menu  (SETTINGS) PAYMENTS > PAYMENT GATEWAYS > STRIPE and authorisation of a refundable payment and explains how to setup a pending payment to ‘Capture/Authorise’ a refundable Security Deposit.

1 Use

You can use this method if:

You have a Stripe account and you have connected it to your property.

And

You require a refundable Security deposit to be authorised on the guest credit card.

If you are in the EU and/or have guests from the EU, you may need to comply with 3DSecure Payments, this will require you to send a payment link to the guest to make the payment directly.

2 How it works

With Stripe you can authorise a payment on a credit card to be released after a fixed period if the payment is not collected. You can define the Due date/time and the amount to be authorised.

3 Set up

Step 1: Setup Stripe Account

Go to (SETTINGS) PAYMENTS > PAYMENT GATEWAYS > STRIPE and set:

Stripe is compatible with the pending payments auto charge function and direct charging a stored card from bookings, when you connect via the ‘Connect’ Button.

  • Click Connect Button. If you have multiple Stripe Accounts, ensure you connect to the correct Stripe account in your Stripe dashboard.
  • Set Enable/Priority - if you plan to use multiple Payment gateways, set the number based on the order on the payment page.
  • Save all cards to Stripe = Yes.
  • Capture = Yes, for your Beds24 booking page, this will collect the payment at the time of the booking.
  • Payment Description - Description for Stripe payments, template variables can be used. This description will be seen in the STRIPE dashboard, this is not visible to the Guest.
  • Title - Customise the title for this payment option.
  • Instruction - Create an optional description to appear next to the Stripe pay now button.

Step 2: Create a Payment Rule - Capture Refundable Security Deposit

Go to (SETTINGS) PAYMENTS > PAYMENT RULES

Create a Payment Rule to authorise a refundable payment.

Click Create New Payment Rule :

Payment Rule:

  • Name = Enter your title - Security Deposit (for example)
  • Action = Auto

Payment Trigger :

  • Booking Status = All not cancelled
  • Any Booking Info Code (optional)
  • All Booking Info Codes (optional)
  • Exclude Booking Info Code= BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT If you have virtual credit cards from the channels, then use this option.

You will need to send a payment request link to the guest for them to authorise the payment as it is not possible to authorise a refundable payment on a Virtual Card.

Payment Action :

  • Funding Source = Guest card only
  • Payment value adjustment = Default
  • Capture = NO - Authorised for collection later
  • Add info code on success = add a Booking Info item to the booking on success
  • Add info code on failure = add a Booking Info item to the booking on failure

Prevent Auto Payment :

  • Prevent payment if booking status : Cancelled
  • Prevent payment after check-out (days) = 7 (default)
  • Prevent payment action : Set Manual

Step 3: Create Auto Actions

Go to (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS and click Create New Action to create them.

If the guest credit card is already at Stripe.

Auto Action 1 - Authorise payment for all bookings - Guest Credit card at Stripe

For bookings via your booking page (direct) and Channel bookings (non virtual cards), the credit card has been sent and stored at Stripe.

Trigger tab:

  • Time
    • Trigger Event = Checkin
    • Trigger Time = -1
    • Time Window = 1 day
  • Booking Source
    • Booking Source =All (this will apply to all bookings, direct, manual and channels). If you want to have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
  • Booking Conditions
    • Group Booking Trigger = Trigger only Master
    • Status = All not cancelled
    • Invoice Balance= Any
  • Info Codes
    • Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT

If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.

Booking tab: Optional

  • Flag Text = Security Deposit Pending Payment (for example)
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.

  • Booking Info Code - REFDEPPP (for example)
  • Booking Info Text - Refundable Security Deposit pending payment

Invoice tab:

  • Add a Pending Payment to the booking
    • Payment Type = Fixed amount
    • Description = the text you will see in the "Charges and Payments" tab
    • Status = if you use the status function add the status you want to apply to the pending payment (optional)
    • Amount = 250 (enter the value you want to authorise on the guest credit card )
    • Payment Rule = Security Deposit (use the payment rule in Step 2)
    • Payment Due = Trigger date
    • Payment time = set the time to collect payment
    • Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.

If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.


Auto Action 2 - Send Payment Request with link for Security Deposit Authorisation

Can be used for channel bookings with virtual cards or properties/guests in EU countries and required to comply with EU 3DSecure regulations.

Trigger tab:

  • Time
    • Trigger Event = Checkin
    • Trigger Time = -1
    • Time Window = 1 day
  • Booking Source
    • Booking Source =All (this will apply to all bookings, direct, manual and channels). If you want to have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
  • Booking Conditions
    • Group Booking Trigger = Trigger only Master
    • Status = All not cancelled
    • Invoice Balance= Any

Message tab:

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain Text Box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL, change the pay=250 to the value you require. see here


Dear [GUESTNAME],

There is a £250(€) Refundable Security Deposit required for your Stay at [PROPERTYNAME].

Please use the link below so the Security Deposit can be authorised.

https://beds24.com/bookpay.php?bookid=[BOOKID]&g=st&capture=0&pay=250

The Security Deposit will be authorised from your Credit Card and will be released when checks are completed and no damage reported.

Best Regards,

[PROPERTYNAME]

  • HTML box - Email will be sent

Email Text :- enter the Email text you wish to send to your guests include URL, change the pay=250 to the value you require. Template variables can be used. see here

Dear [GUESTNAME],

There is a £250(€) Refundable Security Deposit required for your Stay at [PROPERTYNAME].

Please use the link below so the Security Deposit can be authorised.

https://beds24.com/bookpay.php?bookid=[BOOKID]&g=st&capture=0&pay=250

The Security Deposit will be authorised from your Credit Card and will be released when checks are completed and no damage reported.

Best Regards,

[PROPERTYNAME]


Booking tab: Optional

  • Flag Text = Security Deposit Pending Payment (for example)
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking Info tab:

  • Optional, add a booking info tab for information and reporting

Booking Info tab: Optional, for information and reporting

  • Booking Info Code = PAYREQ (for example enter the value - use one word only)
  • Booking Info Text = Enter the description/text to show in for the Booking Info Code.

4 Credit Card details at Stripe

The card will be saved as a new customer in Stripe with the booking number as a reference. Once the new customer is created in Stripe the card can be charged.

Multiple cards can be sent for each Stripe customer and a specific one selected when charging.

Stripe will only accept valid cards. If Stripe reject the card, it's details will still be visible at Beds24.

Info Codes in the "Info" tab of the booking show you which action was performed.

Code Use
CARDTOSTRIPE card details were sent to Stripe
STRIPEPAYMENT payment imported from Stripe
STRIPEFAIL card could not be sent to Stripe
CARDEXPIRES added when the card expires before check-in
STRIPEAUTHORIZE payment has been authorised by Stripe
STRIPEREFUND refund has been processed at Stripe
CARDFAILSTRIPE card has failed at Stripe, see the note for reason
Retrieved from "https://wiki.beds24.com/index.php?title=Stripe_Security_Deposit_capture&oldid=25459"