Difference between revisions of "Custom Gateway"

From Beds24 Wiki
Jump to navigation Jump to search
Line 3: Line 3:
  
 
Required skills: html, programming
 
Required skills: html, programming
 +
 +
== Introduction ==
  
 
You can create an interface to an external (not integrated) payment gateway.
 
You can create an interface to an external (not integrated) payment gateway.
  
 
The booker will be shown a button which will take them to the specified URL with the value from "Post Data" included as an HTML POST.
 
The booker will be shown a button which will take them to the specified URL with the value from "Post Data" included as an HTML POST.
 +
 +
== Transfer to Custom Gateway ==
  
 
Both the URL and POST fields can contain template variables to include values from the booking.
 
Both the URL and POST fields can contain template variables to include values from the booking.
Line 13: Line 17:
  
 
  i.e. deposit=[PAYMENTAMOUNT]&bookid={BOOKID] will post fields deposit and bookid to the external gateway.
 
  i.e. deposit=[PAYMENTAMOUNT]&bookid={BOOKID] will post fields deposit and bookid to the external gateway.
 +
 +
== Webhook to notify of payment status ==
  
 
A notify URL is available for the external gateway to report a successful collection of the deposit.
 
A notify URL is available for the external gateway to report a successful collection of the deposit.

Revision as of 15:37, 4 March 2020

This page is about the menu SETTINGS->PAYMENTS->PAYMENT GATEWAYS->CUSTOM GATEWAY

Required skills: html, programming

1 Introduction

You can create an interface to an external (not integrated) payment gateway.

The booker will be shown a button which will take them to the specified URL with the value from "Post Data" included as an HTML POST.

2 Transfer to Custom Gateway

Both the URL and POST fields can contain template variables to include values from the booking.

A special template variable [PAYMENTAMOUNT] will contain the value of the deposit when booking and the value of the payment request when used for payment requests.

i.e. deposit=[PAYMENTAMOUNT]&bookid={BOOKID] will post fields deposit and bookid to the external gateway.

3 Webhook to notify of payment status

A notify URL is available for the external gateway to report a successful collection of the deposit.

The notify will add the deposit to the booking invoice and trigger updates to booking status and email notifications to guest and host.

The notify must post a key field with a value that matches to setting and contain at least 6 characters.

Notify URL https://api.beds24.com/custompaymentgateway/notify.php

The notify should contain the following POST fields:
key = value in custom gateway key setting
bookid = the bookid of the booking
These POST fields are optional:
status = booking status, 0 (cancelled), 1 (confirmed), 2 (new), 3 (request)
amount = amount of the deposit collected
description = description of payment for invoice item
payment_status = status of payment for invoice item
txnid = unique id for this payment to prevent false duplicates

4 Payment gateways with specific requirements

The payment values can be first posted to your server. Your server can process the data and convert it into the format required by the payment gateway. Finally redirecting the guest to the payment gateway with the data in the required format.