Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Status

Final

Withdrawable

Description

CREATED

no

yes

Payment is created and waiting for the user.

SEEN

no

yes

User opens the Everifin Paygate web page or processing via Process Order endpoint is started.

PROCESSING

no

no

The payment is being processed (user is authorizing payment on bank`s page or authorization is done and payment is being processed in the bank).

CONFIRMED

yes

no

The payment has been successfully authorized in the bank by the payer.

BOOKED

yes

no

The payment has been booked (settled) in the bank.

WITHDRAWN

yes

no

The payment has been withdrawn by merchant.

FAILED

yes

no

Payment has failed.

Field reasonCode will provide more information about the failure. Possible values are described below in separate table.

EXPIRED

yes

no

Payments that stay in CREATED or SEEN for a long time are eventually moved to this state.

PROCESSING_EXPIRED

yes

no

The payment is being processed, but we are unable to retrieve its status from the bank, because access granted by the payer has expired.

...

Recommended reactions to payment statuses

The following table describes recommendations on the behavior of the merchant’s system once it obtains the payment status. This normally happens in these cases:

  • merchant’s “thank you” web page displayed after the customer is redirected back from Everifin Paygate (or when customer goes back in browser)

  • webhook (if implemented by merchant).

Status

Situation

Thank you page behavior

Webhook behavior

CONFIRMED

BOOKED

The payment was successful

Information about the successful payment is displayed to customer.

The merchant’s order should be updated to reflect the payment success and further processes related to this fact can be initiated (invoice generation, notification email to customer, shipping process etc.).

FAILED

EXPIRED

The payment was not successful.

Information about the unsuccessful payment should be displayed to customer. Customer should be able to restart only the checkout process with existing shopping cart (so there is no need to start the whole shopping process over).

The merchant’s order should be updated to reflect the unsuccessful payment. Further actions related to this fact could be initiated (e.g. notification email sent to customer containing the link to page of the existing order where the customer could redo the checkout (with different payment method for example).

WITHDRAWN

The merchant withdrew the payment via API call (possible only when the customer has not yet started the authorization process).

The explanation why the payment has been withdrawn by the merchant should be displayed.

The merchant’s system already has the confirmation the withdrawal of the payment has been successful (in the response of the withdraw API call), so probably nothing has to be done anymore by webhook.

PROCESSING_EXPIRED

We are not able to get the payment status from the bank anymore (the grant given by the customer in the bank for us to get the payment status expired). This is rare edge case. Usually when customer leaves the payment authorization process.

Here the merchant has multiple options. The decision might be based on the business specifics (i.e. what goods or services is the merchant selling, if it is crucial to know the payment status instantly or the merchant can endure some delay - e.g. waiting with shipping until receiving of the money is confirmed on the bank account).

We are offering also service of connecting the collection bank account to cover these cases.

Some behavior options:

  • Treat this as unsuccessful payment (and then process potential refund in case the money arrives)

  • Inform the customer the payment is being still checked and she/he will be informed via email (or other channels) once it happens.

Similar to “thank you” page behavior.

PROCESSING

In some edge cases it might happen the bank is processing the payment bit longer and the customer is informed by this fact by Paygate and then redirected back to merchant.

This status describes the fact we are still checking the payment status.

In this case it is also up to the merchant what behavior he chooses (depends on his business and preferences). Some possible options:

  • Inform the customer the payment is being still checked and she/he will be informed via email (or other channels) once it happens.

  • Treat this as unsuccessful payment (and then process potential refund in case the money arrives)

The merchant’s system may update related order to status reflecting the payment is already being processed.

CREATED

SEEN

The payment is only initiated by the merchant system via API (CREATED) or has been seen on paygate web page by customer (SEEN). The payment can be in this statuses if the customer does not start the authorization and goes back in the browser and gets to “thank you” page.

If the customer gets to “thank you” page, merchant could withdraw the payment by calling withdraw endpoint and then let the customer restart the checkout process. If the customer chooses Everifin again, new payment would be initiated by the merchant’s system. After the withdraw of the payment the behavior could continue as in the case of statuses FAILED or EXPIRED.

If the payment is not withdrawn, it will expire in 30 minutes (status EXPIRED).

No action when the payment is moved to SEEN as it indicates the customer visited the Everifin payment page and might continue with authorization.

Payment status flow chart

Following diagram illustrates possible transitions between payment states:

...

Drawio
mVer2
zoom1
simple0
inComment0
custContentId2500263990
pageId2467561491
lbox1
diagramDisplayNameUntitled Diagram-1686920007024.drawio
contentVer5
revision5
baseUrlhttps://everifin.atlassian.net/wiki
diagramNameUntitled Diagram-1686920007024.drawio
pCenter0
width579.5
links
tbstyle
height686

...