General Information
This document provides a comprehensive overview of the integration process and the utilization of the VIRTUAL PAYMENT GATEWAY protocol for merchants. This integration method offers a suitable solution for merchants exclusively accepting NAPS (Local Qatari Debit Cards).
VIRTUAL PAYMENT GATEWAY protocol implements acquiring payments (purchases) with using specific API interaction.
VIRTURAL PAYMENT GATEWAY protocol refers to Payment Gateways provisioning only redirection model. TESS Payments redirects payer to Payment Gateway's checkout page e.g. NAPS
Definitions
In S2S APM section, please replace "{{API_HOST}}" with the provided URL in each API sample.
List of possible actions/results/statuses in Payment Platform
- Actions
- Results
- Statuses
| Action | Description |
|---|---|
| SALE | Creates SALE transaction |
| CREDITVOID | Creates REFUND transaction |
| GET_TRANS_STATUS | Gets status of transaction in Payment Platform |
Result – value that system returns on request. Possible results are:
| Result | Description |
|---|---|
| SUCCESS | Action was successfully completed in Payment Platform |
| DECLINED | Result of unsuccessful action in Payment Platform |
| REDIRECT | Additional action required from requester |
| ACCEPTED | Action was accepted by Payment Platform, but will be completed later |
| ERROR | Request has errors and was not validated by Payment Platform |
Status – actual status of transaction in Payment Platform. Possible statuses are:
| Status | Description |
|---|---|
| PREPARE | Status is undetermined, final status will be sent in callback |
| REDIRECT | The transaction awaits SALE |
| SETTLED | Successful transaction |
| REFUND | Transaction for which refund was made |
| DECLINED | Not successful transaction |
Errors
In case error you get synchronous response from Payment Platform:
| Parameter | Description |
|---|---|
result | ERROR |
error_message | Error message |