...
Order initialization - redirect URL and payment ID are present in the response
Order processing - Redirecting to URL obtained in step 1. Details can be found here: Redirect Flow
Checking status
Either by getting the order detail (Get Order endpoint) - it provides detail of the order together of details of all its payments
Or by getting the detail of the specific payment in the order (Get Order Payment endpoint)
Order statuses
...
Status
...
Withdrawable
...
Description
...
UNPAID
...
yes
...
Payment of the order is not paid yet. The order is withdrawable in this status in case the related payment is in one of statuses CREATED and SEEN.
...
PARTIALLY_PAID
...
no
...
Payment of the order is paid but order amount is higher than the paid payment amount (this can happen by updating the order with higher amount what creates another payment in the order which is to be paid).
...
PAID
...
no
...
The order is fully paid.
Payment statuses
During the payment process the payment changes its status. The status defines not only state of the payment, but also possible operations - payments in some statuses cannot be updated or cancelled.
...
Following diagram ilustrates possible transitions between payment states:
...
Payment status flow chart
...
Reason code | Description |
|---|---|
CANCELED_BY_PAYER_AT_EVERIFIN | Payer rejected the payment on Everifin Paygate page before authorization has been initiated. |
BANK_NOT_FOUND | Payer has not found the desired bank and wants to choose different payment method at the merchant's site. |
MANUAL_TRANSFER_REQUESTED | Payer has not found the desired bank and decided to receive payment details for the manual bank transfer via email (generating and sending the email to customer need to be handled by merchant). This feature is turned off by default. |
CANCELED_BY_PAYER_AT_BANK | Payer canceled the payment on the bank’s page. |
INSUFFICIENT_AMOUNT | Payer does not have enough funds on his account to make the payment. |
AML_BLOCKED | Payer’s funds have been blocked at the bank as a result of bank’s AML checks. Payer needs to contact the bank to treat the situation further. |
REJECTED_BY_BANK | The bank rejected the payment due to some failure. Issue needs to be further analyzed (sometimes the reason is the payer canceled the payment on the bank’s pages but we are not able to identify this situation because the bank does not inform about it). |
OTHER | Other, unspecified failure reasons (e.g. payment authorization failed, bank API temporary outage etc.) |
Order statuses
Status | Withdrawable | Description |
|---|---|---|
UNPAID | yes | Payment of the order is not paid yet. The order is withdrawable in this status in case the related payment is in one of statuses CREATED and SEEN. |
PARTIALLY_PAID | no | Payment of the order is paid but order amount is higher than the paid payment amount (this can happen by updating the order with higher amount what creates another payment in the order which is to be paid). |
PAID | no | The order is fully paid. |
API v1 vs. v2
Main differences between API v1 and v2 are:
...