Overview

Enviroments

ENV	URL
Producation	https://api.freedompay.kz
Test	https://test-api.freedompay.kz

Request header

Name	Value	Description
Content-type	application/json	Request body format
X-JWS-Signature	string	Request signature

request-id must be unique. If duplicates are found, an error will be returned and the request will not be processed.

API field formats

Type	Format
string	[a-zA-Z0-9`*()@#$!~-_,.\|/+=^&]
string(datetime)	ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm
string(uuid)	uuid
string(date)	ISO 8601 YYYY-MM-DD

Authorization

Request authorization occurs by generating and passing the JWS token in the X-JWS-Signature header.
The JWS is the part of the JWT token that contains only the header and signature.
Request type application/json.

Signature

To generate the request signature, you must have the secret and perform the following steps:

minify the request body

create an HS256 JWT signature

remove the payload from the generated JWT

add the resulting signature to the request header X-JWT-Signature

Signature example

Request Body:

{
    "request_id":"828cf71d-a447-4a67-a149-c1df8bc197ca",
    "card_id":"828cf71d-a447-4a67-a149-c1df8bc197ca"
}

JWT token header:

{
    "alg": "HS256",
    "typ": "JWT",
    "auth_id": "56155",
    "uri": "/v5/card-api/card/info",
    "method": 'POST',
    "params": ""
}

JWT token with HS256 signatire

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImF1dGhfaWQiOiI1NjE1NSIsInVyaSI6Ii92NS9jYXJkLWFwaS9jYXJkL2luZm8iLCJtZXRob2QiOiJQT1NUIiwicGFyYW1zIjoiIn0.eyJyZXF1ZXN0X2lkIjoiODI4Y2Y3MWQtYTQ0Ny00YTY3LWExNDktYzFkZjhiYzE5N2NhIiwiY2FyZF9pZCI6IjgyOGNmNzFkLWE0NDctNGE2Ny1hMTQ5LWMxZGY4YmMxOTdjYSJ9.4dVsi1MsimSiwSaCayifqQpuDbg5sCh6Q155cw58TaI

Result signature:
You have to cut out the part containing payload from the JWT token and get the following line:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImF1dGhfaWQiOiI1NjE1NSIsInVyaSI6Ii92NS9jYXJkLWFwaS9jYXJkL2luZm8iLCJtZXRob2QiOiJQT1NUIiwicGFyYW1zIjoiIn0..4dVsi1MsimSiwSaCayifqQpuDbg5sCh6Q155cw58TaI

Result string is the signature of the request and must be passed in the X-JWS-Signature request header parameter.

Signature postman script

Test parameters

Parameter	Value
card-id

Timeouts

If you do not receive a response to the request within 30 seconds, you must query its status using your request-id. If the response indicates that such a request does not exist, you may resend the request.
Synchronous methods support repeated requests with identical parameters.

Error response

API requests may return errors with HTTP codes 400, 401, 404, 422, or 500
The error response format is as follows:

response.error

Enviroments#

Request header#

API field formats#

Authorization#

Signature#

Signature example#

Signature postman script#

Test parameters#

Timeouts#

Error response#

Enviroments

Request header

API field formats

Authorization

Signature

Signature example

Signature postman script

Test parameters

Timeouts

Error response