Changes

Jump to navigation Jump to search

Custom Gateway

2,112 bytes added, 17:41, 23 October 2021
no edit summary
[[Category:Payments]]
[[Category:Payment_Gateways]]
<div class="heading">Custom Gateway</div>
This page is about the menu {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT GATEWAYS > CUSTOM GATEWAY and explains how to connect with a payment gateway of your choice.
[[Category<span style="color:Deposit_Collection]] ''This page is about the menu SETTINGS#f3e504; font-size: 250%;" >PROPERTIES-{{#fas:lightbulb}} </span>DEPOSIT COLLECTION->CUSTOM GATEWAY''Required skills: html, programming__TOC__= Introduction =
Required skills: html, programmingYou can create an interface to an external (not integrated) payment gateway.
You can create an interface The booker will be shown a button which will take them to the specified URL with the value from "Post Data" included as an external (not integrated) payment gatewayHTML POST= Transfer to Custom Gateway =
The booker will be shown a button which will take them post data is sent to the specified URL custom gateway with a POST fieldsmethod as if it came from a normal HTML form being submitted on a web page.
Both the URL and POST fields can contain template variables to include values from the booking.
For example If the POST fields are empty, a GET request is made to the specified URL. A special template variable [DEPOSITPAYMENTAMOUNT] will contain the value of the depositwhen booking and the value of the payment request when used for payment requests.
i.e. '''Example''': <code> deposit=[DEPOSITPAYMENTAMOUNT]&bookid={BOOKID] </code> will post fields deposit and bookid to the external gateway. *The custom gateway POST data is posted from the users browser when they click the pay button.*This means the POSTED data will be visible in the page source code and should not contain any secret or private data. = Confirmation Page = The payment gateway should show the payment status to the booker confirming the success or failure of their payment. After the booking (and sending the webhook to notify of payment success) the booker can be returned to the page booking.php?page=bookconfirmed which will show the booking they just made. = 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 must post a key field with a value that matches to setting and contain at least 6 characters.
The data should be sent as HTML POST form data Notify URL : https://api.beds24.com/custompaymentgateway/notify.php  The notify should contain the following POST fields:
<code>key</code>= value in custom gateway key setting
<code>bookid</code> = the bookid of the booking
 
These POST fields are optional:
 
<code>status</code> = booking status, 0 (cancelled), 1 (confirmed), 2 (new), 3 (request)
 
<code>amount</code> = amount of the deposit collected
 
<code>description</code> = description of payment for invoice item
 
<code>payment_status</code> = status of payment for invoice item
 
<code>txnid</code> = unique id for this payment to prevent false duplicates
 
 
A success will have HTTP 200 response with no text.
If there is any text content in the response, it will be an error message which means it was not successful.
 
= 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.
The notify should contain the following POST fields: key = value in custom gateway key setting bookid = the bookid of Examples where this may be required are adding authorization headers or passwords or transforming the booking amount = amount of data into a specific format required by the deposit collected description = description of payment for invoice item status = status of payment for invoice item txnid = unique id for this payment to prevent false duplicatesgateway.

Navigation menu