Paygate API

To test Paygate API you can use any of well-known REST tools, e.g. Postman.

API documentation

See the API documentation for specific API request and response examples: Everifin PayGate API doc

Request HTTP headers

All requests except authentication (get access token) must contain following headers.

API endpoints

Authentication

• get access token

POST {{everifin_idp_url}}/auth/realms/everifin_paygate/protocol/openid-connect/token

Banks

• get list of supported banks

GET {{everifin_url}}/api/v1/banks

Payments

Redirect flow

• initialize payment for redirect flow

POST {{everifin_url}}/api/v1/link 

Embedded flow

• initialize payment for embedded flow

POST {{everifin_url}}/api/v1/payments 

• process payment in embedded flow

PATCH {{everifin_url}}/api/v1/payments/:id

Common endpoints for all flows

• get payment list

GET {{everifin_url}}/api/v1/payments

• get payment detail

GET {{everifin_url}}/api/v1/payments/:id

• cancel payment

DELETE {{everifin_url}}/api/v1/payments/:id

Response structure

All endpoints, except token endpoint, are responding with following structure:

Success response

Successful request returns a response with following structure.

{
    "meta": {
        "status": "SUCCESS"
    },
    "data": 
      ...
}

Error response

Erroneous request returns a response with following structure.

{
    "meta": {
        "status": "ERROR"
    },
    "errors": [
        {
            "code": "PAYMENT_NOT_FOUND",
            "title": "Payment with given id was not found."
        }
    ]
}

Error response object

Error response contains response object(s) which has following structure. List of error codes can be found here: Paygate Error Codes