Get Access Token

Mandatory

Endpoint to get access token which is required to call Everifin Paygate API.

As the token has very short validity, you need to make sure you have valid one before calling any API endpoint.

It is up to merchant to choose the way of getting it:

• active approach - based on its lifetime, before it expires

• or passive approach - get new one once 401 error response is obtained

https://everifin.atlassian.net/wiki/spaces/EPAD/pages/2467561515/Authentication#Get-authentication-token

Get Banks

Optional

Endpoint to get list of banks.

List of available/supported banks can be displayed to customer so he can decide before he chooses the payment method.

List of banks

Create Order Payment

Mandatory

Endpoint to initiate payment and get payment link

Beside all mandatory fields, populate these fields:

• reference/variableSymbol - these are important to identify the payment and also to map it to particular money transfer on merchant’s bank account statement. In Slovakia and Czechia also the fields specific and constant symbol can be used.

• paymentMessage - it is good practice to use appropriate message so your customers can easily identify the payments in their bank even after some time (e.g. text containing eshop name)

• recipientName - name of the eshop/merchant. This is also important for the customers to identify the money transfer in their bank

• userLocale - please send proper value in this field to display the paygate page in correct language to your customers.

The response provides payment ID which needs to be stored to the purchase order in merchant’s system and also redirect URL the customer should be redirected to.

https://everifin.atlassian.net/wiki/spaces/EPAD/pages/2562228372/Payment+Orders#Order-initialization

Get Order Payment Detail

Mandatory

Endpoint to get payment detail after redirect back to merchant (and/or after reasonable time when no redirect happens)

This endpoint needs to be called after the payer is redirected back to merchant’s page/app (thank you page or failure page in case of cancel) to get current status of the payment (merchant receives payment ID in the query parameter when redirect URL is called).

The order needs to be find based on the payment ID provided in the redirect (merchant need to ensure the order related to this particular payment is being processed based on the payment result).

This endpoint can be called also in some reasonable time period after the payment has been initiated in the case the payer does not come back to merchant’s site/app (e.g. when the payer closes the browser before she/he is redirected back to merchant).

Response of this endpoint can be used to double check the data against the data in initial order (amount, reference etc.)

https://everifin.atlassian.net/wiki/spaces/EPAD/pages/2562228372/Payment+Orders#Order-detail

Order Withdrawal

Optional

Endpoint to withdraw the initiated payment by the merchant

In case the merchant needs to withdraw the payment that has been already initiated (endpoint Create Order Payment called successfully), this endpoint can be called.

It is possible to withdraw the payment only in case the payment authorization has not start yet. The details when the withdrawal is possible is described in the doc

After redirect back to merchant, the payment is still in PROCESSING status.

In some rare cases it may happen the payment is not in final status at the moment of redirection back to merchant but still in PROCESSING status (i.e. the bank has not processed the payment yet).

Merchant should inform the customer the payment is still being processed and that the customer will be notified once the payment is processed successfully (via email, in the customer’s e-shop account etc.). The merchant needs to implement background process of payment status checking (webhooks or polling payment detail endpoint in some intervals , or, once available, use web hooksas backup).

Customer interrupts the payment process and does not return to merchant’s e-shop page.

These situations can be handled by webhooks functionality. Alternatively this can be treated by As a backup solution, process of polling the payment detail endpoint by the client in some interval . However this is much worse approach comparing to webhooksshould be implemented by the merchant.