Flow steps for online payments (possible errors are not included in the main flow steps, they are outlined further in this document):

  1. A shopper chooses to pay for some goods using a particular payment method.
  2. A transaction is initiated via the integrator's commercial site integrated with PMG (transaction details such as amount, payment method, currency etc.).
  3. A transaction authorisation request is then sent to PMG using the exposed API described in the sections below in this document.
  4. The request is first validated by the PMG and if valid, sent to the payment method provider for validation (directly or through another payment acquirer). For synchronous payment methods the PMG response to the integrators commercial site is final (sync/async info for each of the payment methods is included in a table with the payment methods supported later in this document):
    • If the payment is not valid then a DECLINED status is returned by the PMG;
    • If the payment is valid, then a PENDING status is returned (for asynchronous payment methods);
    • If the payment is valid, then a SUCCEEDED status is returned (for synchronous payment methods).
  5. For asynchronous payment methods and if the transaction status returned is PENDING, the shopper is redirected to a page of the payment provider to finalise the payment (e.g. a page where the shopper has to complete bank account details or the online banking page of the shopper etc.).
  6. For asynchronous payment methods after the shopper submits the payment with the requested by the provider additional details, they are redirected back to the integrators commercial site and the PMG waits for a final status from the payment method provider.
  7. Once a final status of the payment is received, it triggers the PMG to send a status change notification to the integrator's commercial site with a final transaction status - SUCCEEDED or DECLINED.
  8. Based on the status change notification, the integrator's commercial site sends to the PMG a check status request thus receiving a final status of the transaction.
  9. If a payment method is guaranteed, then the response on the check status request will include a final status of the authorisation request plus a final funds status for the transaction, so step 8 will be the last in the payment flow.
  10. If the payment method is not guaranteed, then a new status change notification is sent by the PMG after the funds have been secured. For some of the payment methods provided it could take days between the technical success of the transaction and the funds received status notification (additional table is added later in the document with the list of payment methods + information about guarantee and funds status update delays).
  11. For payment methods that are not guaranteed after a status change notification is received, a check status should be sent again to PMG for an update of the funds status of the transaction.

There are several types of calls in this flow (detailed in the next sections):

  • Transaction authorisation request
  • Transaction authorisation response
  • Status update notification
  • Check status update request
  • Check status update response
Note: After a transaction authorisation request has been received by PMG, there is no possibility to reverse it (cancel or void). The only way is to send a refund request for the transaction.