Custom Gateway - Revision history

Markkinchin: /* Webhook to notify of payment status */

2025-06-12T13:04:38Z

Webhook to notify of payment status

← Older revision		Revision as of 13:04, 12 June 2025
Line 56:		Line 56:
	These POST fields are optional:		These POST fields are optional:

	<code>status</code> = booking status, 0 (cancelled), 1 (confirmed), 2 (new), 3 (request)		<code>status</code> = booking status, 0 (cancelled), 1 (confirmed), 2 (new), 3 (request) or -2 (nochange)

	<code>amount</code> = amount of the deposit collected		<code>amount</code> = amount of the deposit collected

Lesley: /* Transfer to Custom Gateway */

2024-10-15T08:20:30Z

Transfer to Custom Gateway

← Older revision		Revision as of 08:20, 15 October 2024
Line 22:		Line 22:
	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.		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.

	'''Example''': <code> deposit=[PAYMENTAMOUNT]&bookid={BOOKID]</code> will post fields deposit and bookid to the external gateway.		'''Example''': <code> deposit=[PAYMENTAMOUNT]&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.		*The custom gateway POST data is posted from the users browser when they click the pay button.

Markkinchin: /* Webhook to notify of payment status */

2024-10-14T14:38:17Z

Webhook to notify of payment status

← Older revision		Revision as of 14:38, 14 October 2024
Line 41:		Line 41:
	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 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.		The notify must post a key value that matches the value in the key setting and contain at least 6 characters.

	The data should be sent as HTML POST form data		The data should be sent as HTML POST form data

Sorenjensen: /* Confirmation Page */

2023-11-10T14:14:28Z

Confirmation Page

← Older revision		Revision as of 14:14, 10 November 2023
Line 32:		Line 32:

	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.		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.

			The booking is a stored in a session variable, which means that the confirmation page needs to be on the same domain as the booking otherwise it wont work or if it's in incognito mode and might time out after 15 minutes.

	= Webhook to notify of payment status =		= Webhook to notify of payment status =

Markkinchin at 15:41, 23 October 2021

2021-10-23T15:41:43Z

← Older revision		Revision as of 15:41, 23 October 2021
Line 26:		Line 26:
	*The custom gateway POST data is posted from the users browser when they click the pay button.		*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.		*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 =		= Webhook to notify of payment status =

Markkinchin: /* Transfer to Custom Gateway */

2021-05-09T11:04:04Z

Transfer to Custom Gateway

← Older revision		Revision as of 11:04, 9 May 2021
Line 14:		Line 14:
	= Transfer to Custom Gateway =		= Transfer to Custom Gateway =

	The post data is sent to the custom gateway as if it came from a normal HTML form being submitted		The post data is sent to the custom gateway with a POST method 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.		Both the URL and POST fields can contain template variables to include values from the booking.

			If the POST fields are empty, a GET request is made to the specified URL.

	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.		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.

Annette at 10:24, 20 November 2020

2020-11-20T10:24:12Z

← Older revision		Revision as of 10:24, 20 November 2020
Line 2:		Line 2:
	[[Category:Payment_Gateways]]		[[Category:Payment_Gateways]]
	<div class="heading">Custom Gateway</div>		<div class="heading">Custom Gateway</div>
	This page is about the menu SETTINGS->PAYMENTS->PAYMENT GATEWAYS->CUSTOM GATEWAY and explains how to connect with a payment gateway of your choice.		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.

	<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Required skills: html, programming		<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Required skills: html, programming

Annette: /* Transfer to Custom Gateway */

2020-05-11T18:45:19Z

Transfer to Custom Gateway

← Older revision		Revision as of 18:45, 11 May 2020
Line 20:		Line 20:
	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.		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.

	Example: <code> deposit=[PAYMENTAMOUNT]&bookid={BOOKID]</code> will post fields deposit and bookid to the external gateway.		'''Example''': <code> deposit=[PAYMENTAMOUNT]&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.		*The custom gateway POST data is posted from the users browser when they click the pay button.

Annette: /* Webhook to notify of payment status */

2020-05-11T18:44:59Z

Webhook to notify of payment status

← Older revision		Revision as of 18:44, 11 May 2020
Line 36:		Line 36:
	The data should be sent as HTML POST form data		The data should be sent as HTML POST form data

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


	The notify should contain the following POST fields:		The notify should contain the following POST fields:
	key = value in custom gateway key setting
	bookid = the bookid of the booking		<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

	~~These POST fields are optional:~~		<code>txnid</code> = unique id for this payment to prevent false duplicates
	~~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

Annette: /* Transfer to Custom Gateway */

2020-05-11T18:42:03Z

Transfer to Custom Gateway

← Older revision		Revision as of 18:42, 11 May 2020
Line 20:		Line 20:
	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.		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.		Example: <code> deposit=[PAYMENTAMOUNT]&bookid={BOOKID]</code> will post fields deposit and bookid to the external gateway.