Payment API - Revision history

Rjnl: Minor correction and adding some missing info.

2022-06-03T02:43:20Z

Minor correction and adding some missing info.

← Older revision		Revision as of 02:43, 3 June 2022
Line 2:		Line 2:

	Payment API allows Moodle components to have financial interactions with users.		Payment API allows Moodle components to have financial interactions with users.

	=== Trigger the payment modal ===		=== Trigger the payment modal ===

	In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:		In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:

	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<button		<button
Line 17:		Line 14:
	>		>
	{{# str }} sendpaymentbutton, enrol_fee {{/ str }}		{{# str }} sendpaymentbutton, enrol_fee {{/ str }}
	<button>		</button>

			{{#js}}
			require(['core_payment/gateways_modal'], function(modal) {
			modal.init();
			});
			{{/js}}
	</syntaxhighlight>		</syntaxhighlight>

	=== The service_provider class ===		=== The service_provider class ===

	All components that want to use the payment API have to implement the \core_payment\local\callback\service_provider interface.		All components that want to use the payment API have to implement the \core_payment\local\callback\service_provider interface.

	==== get_payable ====		==== get_payable ====

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;		public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
	</syntaxhighlight>		</syntaxhighlight>

	This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to.		This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to.

	==== deliver_order ====		==== deliver_order ====

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;		public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
	</syntaxhighlight>		</syntaxhighlight>

	This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.		This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.

	==See also==		==See also==

	* User documentation [[:en:Payment gateways\|Payment gateways]]		* User documentation [[:en:Payment gateways\|Payment gateways]]

Mudrd8mz: Text replacement - "`" to ""`


2021-07-15T08:13:09Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:13, 15 July 2021
				
Line 7:
Line 7:
In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following: In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:



<code xml> <syntaxhighlight lang="xml">
<button <button
     data-action="core_payment/triggerPayment"      data-action="core_payment/triggerPayment"



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:32:39Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:32, 14 July 2021
				
Line 26:
Line 26:
==== get_payable ==== ==== get_payable ====



<code php> <syntaxhighlight lang="php">
public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable; public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
</syntaxhighlight> </syntaxhighlight>
Line 34:
Line 34:
==== deliver_order ==== ==== deliver_order ====



<code php> <syntaxhighlight lang="php">
public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool; public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
</syntaxhighlight> </syntaxhighlight>



Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:04:23Z
Text replacement - "</code>" to "</syntaxhighlight>"

				
				
				
				
				
				← Older revision
				Revision as of 13:04, 14 July 2021
				
Line 18:
Line 18:
     {{# str }} sendpaymentbutton, enrol_fee {{/ str }}      {{# str }} sendpaymentbutton, enrol_fee {{/ str }}
<button> <button>
</code> </syntaxhighlight>



=== The service_provider class === === The service_provider class ===
Line 28:
Line 28:
<code php> <code php>
public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable; public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
</code> </syntaxhighlight>



This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to. This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to.
Line 36:
Line 36:
<code php> <code php>
public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool; public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
</code> </syntaxhighlight>



This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them. This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.



Bencellis: /* Triger the payment modal */
2021-04-28T10:32:04Z
Triger the payment modal

				
				
				
				
				
				← Older revision
				Revision as of 10:32, 28 April 2021
				
Line 3:
Line 3:
Payment API allows Moodle components to have financial interactions with users. Payment API allows Moodle components to have financial interactions with users.



=== Triger the payment modal === === Trigger the payment modal ===



In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following: In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:



Tsala: see also user doc link
2021-01-22T08:06:33Z
see also user doc link

				
				
				
				
				
				← Older revision
				Revision as of 08:06, 22 January 2021
				
Line 39:
Line 39:



This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them. This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.

==See also==

* User documentation [[:en:Payment gateways|Payment gateways]]



Rezaie9: Created page with "{{Moodle 3.10}}  Payment API allows Moodle components to have financial interactions with users.  === Triger the payment modal ===  In order to trigger the payment modal, all..."
2020-12-13T16:29:46Z
Created page with "{{Moodle 3.10}}  Payment API allows Moodle components to have financial interactions with users.  === Triger the payment modal ===  In order to trigger the payment modal, all..."
New page
{{Moodle 3.10}}



Payment API allows Moodle components to have financial interactions with users.



=== Triger the payment modal ===



In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:



<code xml>

<button

    data-action="core_payment/triggerPayment"

    data-component="enrol_fee"

    data-paymentarea="fee"

    data-itemid="{{itemid}}"

    data-cost="{{coststring}}"

    data-description="{{description}}"

>

    {{# str }} sendpaymentbutton, enrol_fee {{/ str }}

<button>

</code>



=== The service_provider class ===



All components that want to use the payment API have to implement the \core_payment\local\callback\service_provider interface.



==== get_payable ====



<code php>

public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;

</code>



This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to.



==== deliver_order ====



<code php>

public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;

</code>



This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.

← Older revision		Revision as of 08:13, 15 July 2021
Line 7:		Line 7:
	In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:		In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:

	<~~code~~ xml>		<syntaxhighlight lang="xml">
	<button		<button
	data-action="core_payment/triggerPayment"		data-action="core_payment/triggerPayment"

← Older revision		Revision as of 13:32, 14 July 2021
Line 26:		Line 26:
	==== get_payable ====		==== get_payable ====

	<~~code~~ php>		<syntaxhighlight lang="php">
	public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;		public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
	</syntaxhighlight>		</syntaxhighlight>
Line 34:		Line 34:
	==== deliver_order ====		==== deliver_order ====

	<~~code~~ php>		<syntaxhighlight lang="php">
	public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;		public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 13:04, 14 July 2021
Line 18:		Line 18:
	{{# str }} sendpaymentbutton, enrol_fee {{/ str }}		{{# str }} sendpaymentbutton, enrol_fee {{/ str }}
	<button>		<button>
	</~~code~~>		</syntaxhighlight>

	=== The service_provider class ===		=== The service_provider class ===
Line 28:		Line 28:
	<code php>		<code php>
	public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;		public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
	</~~code~~>		</syntaxhighlight>

	This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to.		This is the function that the payment subsystem calls to retrieve the amount and currency of what is being sold, along with the accountid that payments should be paid to.
Line 36:		Line 36:
	<code php>		<code php>
	public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;		public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
	</~~code~~>		</syntaxhighlight>

	This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.		This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.

← Older revision		Revision as of 10:32, 28 April 2021
Line 3:		Line 3:
	Payment API allows Moodle components to have financial interactions with users.		Payment API allows Moodle components to have financial interactions with users.

	=== ~~Triger~~ the payment modal ===		=== Trigger the payment modal ===

	In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:		In order to trigger the payment modal, all you need to do is to place an HTML element with data-action attribute equal to core_payment/triggerPayment in the page. You can use a mustache template with a content similar to the following:

← Older revision		Revision as of 08:06, 22 January 2021
Line 39:		Line 39:

	This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.		This is the function that the payment subsystem calls when a user makes a successful payment. This function should give what the user paid for to them.

			==See also==

			* User documentation [[:en:Payment gateways\|Payment gateways]]