API Methods Overview - csob/paymentgateway GitHub Wiki

Initial integration on eAPI, signature verification

To connect the e-shop to eAPI, initiate an operation call echo. This will test the correct request signing and also the verification of the signature in the response received from the payment gateway. The call can be implemented via both GET and also the POST HTTP method.

Method	Description
echo	Operations to verify the availability of the payment gateway, or also to verify the signature of the message for easier integration.

Basic e-shop integration onto the payment gateway

The payment/init and payment/process operations are used for the basic integration of the e-shop onto the payment gateway:

Method	Description
payment/init	Payment initialisation ot the payment gateway
payment/process	Redirection to the payment gateway after the previous payment initialisation.

It is also necessary to implement the calls for the following operations, which can be used to manage the life cycle of the payment:

Method	Description
payment/status	Checking the status of the payment.
payment/reverse	The operation reverses an already authorised payment (it is cancelled prior to being sent to the settlement).
payment/close	The operation posts the authorised uncharged payment into clearing.
payment/refund	The operation requests a full or partial return of funds back to the payer.

Integration of methods for OneClick payment (oneclick@shop)

If the merchant will use OneClick payment, the following operations oneclick/init and oneclick/process must be implemented. Using the oneclick/echo operation, the merchant can check the status of the OneClick template, for example, when the status of the user’s "registered cards" is displayed.

Method	Description
oneclick/echo	The status of the OneClick template check.
oneclick/init	Initialisation of the OneClick payment at payment gateway.
oneclick/process	Start of OneClick payment processing.

Integration of methods for Apple Pay payment (applepay@shop)

The Apple Pay payment method requires the merchant to implement the following operations:

Method	Description
applepay/echo	Getting parameters for Apple Pay initialisation.
applepay/init	Initialisation of Apple Pay payments for applepay@shop.
applepay/process	Start of Apple Pay payment process.

Integration of methods for Google Pay payment (googlepay@shop)

The Google Pay payment method requires the merchant to implement the following operations:

Method	Description
googlepay/echo	Getting parameters for Google Pay initialisation.
googlepay/init	Initialisation of Google Pay payments for googlepay@shop.
googlepay/process	Start of Google Pay payment process.

Integration of the ČSOB payment button (pt@shop)

To integrate the payment button for payment by transfer from ČSOB accounts, it is necessary for the merchant to implement the button/init method:

Method	Description
button/init	Initialisation of the payment for a payment button (pt@shop).

Integration of methods for mallpay payment (mallpay@shop)

The mallpay payment method differs slightly from previous payment methods: although the merchant first creates a payment using mallpay/init and finds out its status using payment/status, the further processing is different - the merchant can cancel the payment (mallpay/cancel). Furthermore, after delivering or sending the goods to the customer, it passes the logistics status (mallpay/logistics) to the payment gateway and the refund (mallpay/refund) is performed differently.

Methods	Description
mallpay/init	Initialisation of Deferred Payment at the payment gateway for mallpay@shop.
mallpay/logistics	Using this operation, the merchant transmits data on the delivery or dispatch of goods to the customer, or data on cancelled items of the order.
mallpay/cancel	Applying this operation, the merchant can cancel the Deferred Payment.
mallpay/refund	Refund of mallpay payment.

Auxiliary methods

The following operations are optional:

Method	Description
echo/customer	Operation to retrieve the stored customer data.