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:

Request HTTP headers

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

Header

Type

Description

Authorization

Bearer token

Authorization token to access API.

Example:

Authorization: "Bearer your-access-token-value"

Accept

Text

Must be set to application/json

Host-names

Please use the following host-names for endpoints' URLs.

Hostname wildcard

Hostname URL

{{everifin_idp_url}}

https://app.everifin.com

{{everifin_url}}

https://pay.everifin.com

Response structure

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

Property

Optional

Description

meta

no

meta part contains status of the request (SUCCESS, ERROR) and can contain additional information to the response (e.g. pagination)

data

yes

(only for success)

data part contains single (success) response object or array of response objects

errors

yes

(only for errors)

errors part contains array of error response objects

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

Property

Optional

Description

code

no

Error code

title

no

Readable error title