Payment request links and parameters

A payment request link takes the guest to a secure Beds24 page where they pay with the payment options you support. Build the link with a template variable in an Auto Action, or write the URL yourself and control the amount and the payment gateways shown with URL parameters.

Prerequisites: at least one payment option activated in Settings > Payments > Payment Gateways. Setup of payment requests: see How to setup Payments.

Table of Contents

  1. Template variables
  2. Payment request URL
  3. Gateway parameters
  4. Amount parameters
  5. Examples
  6. Request credit card details

Template variables

Template variables create a ready-made payment link, button or URL. Using them is recommended.

Variable Creates Amount requested
[PAYLINK] Payment link (HTML A tag) The booking's deposit field if it isn't zero, otherwise the outstanding balance
[PAYLINK:25%] Payment link (HTML A tag) A percentage of the outstanding balance
[PAYLINK:200] Payment link (HTML A tag) A fixed amount
[PAYBUTTON] Payment button The booking's deposit field if it isn't zero, otherwise the outstanding balance
[PAYBUTTON:25%] Payment button A percentage of the outstanding balance
[PAYBUTTON:200] Payment button A fixed amount
[PAYURL] Payment URL The booking's deposit field if it isn't zero, otherwise the outstanding balance
[PAYURL:25%] Payment URL A percentage of the outstanding balance
[PAYURL:200] Payment URL A fixed amount
  • Percentages: use 100% for the full outstanding balance. A percentage over 100% charges extra, for example a fee for credit card payments.
  • Hide a gateway: add H and the gateway code. For example, [PAYURL:200:HST] hides Stripe. Gateway codes are in Gateway parameters.

Note: [PAYLINK] doesn't work with your own domain. If you use the private label option and want the link on your own domain, write the payment request URL yourself.

More template variables: Template Variables.

Payment request URL

The URL needs at least the booking number. In an Auto Action, the [BOOKID] template variable fills it in automatically:

https://beds24.com/bookpay.php?bookid=[BOOKID]

In a custom email, type the booking number directly:

https://beds24.com/bookpay.php?bookid=1234567

If you've activated a private domain, replace https://beds24.com with your domain:

https://mydomain.com/bookpay.php?bookid=[BOOKID]

Add the parameters below to the URL to control the payment request.

Note: Payment links expire 28 days after check-out.

Gateway parameters

By default, all payment gateways enabled for your booking page show on the payment request page. &g= forces a gateway to show and &h= forces it to be hidden. Both take several gateways, comma separated.

Code Payment gateway
an Authorize.Net
bg Borgun
bp Bitpay
cc Credit card collection
cg Custom Gateway
op Offline Payment
pm Paymill
pp PayPal
ra Realex A
rb Realex B
st Stripe

Capture (Stripe only):

Parameter Effect
capture=0 Don't capture the payment (authorise only)
capture=1 Capture the payment

Amount parameters

Without an amount parameter, the request is for the outstanding balance of the booking. For a group booking, it's the outstanding balance of the group invoice.

Parameter Amount requested
&pay=deposit The amount in the booking's Deposit field
&pay=100 The amount specified (here 100)
&pay=bookbalance The outstanding balance of this booking. If the booking is part of a group and has no outstanding balance, the group balance is requested.
&pay=groupbalance The outstanding balance of the group booking (the default)
&pay=groupbalance&pc=25 A percentage (pc) of the pay amount, here 25% of the group balance
&pay=na No amount: collects credit card details only

Examples

URL Result
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=an Payment link for Authorize.Net
https://beds24.com/bookpay.php?bookid=1234567&g=st,pp Payment link showing Stripe and PayPal
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=st&capture=0 Payment link for Stripe without capturing
https://beds24.com/bookpay.php?bookid=1234567&h=cc Payment link hiding credit card collection
https://beds24.com/bookpay.php?bookid=[BOOKID]&pay=70 Payment link requesting 70

Request credit card details

Ask guests to submit their credit card details on a secure form, for example with an Auto Action.

Prerequisites:

  • Credit card collection activated in Settings > Payments > Credit Card Collection > Credit Card.
  • The cards you accept set in Settings > Payments > Credit Card Collection > Credit Card Rules.

Go to Settings > Guest Management > Auto Actions, create an Auto Action, and in the Email tab click Edit and enter your text with one of these variables:

Variable Creates
[PAYLINK:NA:CC] Link to the form where the guest enters their card details
[PAYURL:NA:CC] URL of the form
[PAYBUTTON:NA:CC] Button with a link to the form

For your own link text, use the URL variable in a link, for example <a href="[PAYURL:NA:CC]">Your text</a>.

Or use a direct link with the booking number and &g=cc&pay=na:

https://beds24.com/bookpay.php?bookid=1234567&g=cc&pay=na
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=cc&pay=na

Custom messages for the header of the form and the confirmation after the guest submits their details: Settings > Payments > Payment Collection (Payment Request Header and Payment Request Confirmation).

Related Articles

Was this article helpful?
0 out of 0 found this helpful

How to Contact us :