...
See the API documentation for specific API request and response examples:
API v1: Everifin PayGate API v1
API v2: Everifin PayGate API
...
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:
|
Accept | Text | Must be set to |
API endpoints
...
Host-names
Please use the following host-names for endpoints' URLs.
Hostname wildcard |
|---|
Hostname URL |
|---|
Production
|
|
Authentication
get access token
| Code Block |
|---|
POST {{everifin_idp_url}}/auth/realms/everifin_paygate/protocol/openid-connect/token |
Banks
get list of supported banks
| Code Block |
|---|
GET {{everifin_url}}/api/v1/banks |
Payments
Redirect flow
initialize payment for redirect flow
| Code Block |
|---|
POST {{everifin_url}}/api/v1/link |
Embedded flow
initialize payment for embedded flow
| Code Block |
|---|
POST {{everifin_url}}/api/v1/payments |
process payment in embedded flow
| Code Block |
|---|
PATCH {{everifin_url}}/api/v1/payments/:id |
Common endpoints for all flows
get payment list
| Code Block |
|---|
GET {{everifin_url}}/api/v1/payments |
get payment detail
| Code Block |
|---|
GET {{everifin_url}}/api/v1/payments/:id |
cancel payment
...
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.
...
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 |