Get token

POST

https://api.freedompay.kz/v5/partner/transfer/agent/auth

Token-Based Authentication
Access to the API is controlled through access tokens and refresh tokens, ensuring secure communication and limiting unauthorized usage.

Description: This method is used to authenticate an agent in the IMTS system. The agent transmits its credentials (agent_ID) and (agent_secret) and receives an access token and a refresh token.

Important
The access token is required to perform all operations related to transfers.
The refresh token is used to extend the session without the need to re-enter credentials.

Request

Body Params application/json

agent_id

string

required

Unique partner identifier, provided by support

agent_secret

string

required

Partner's secret key, used for authentication, provided by support

Example

{
  "agent_id": "string",
  "agent_secret": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/partner/transfer/agent/auth' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agent_id": "string",
    "agent_secret": "string"
}'

Responses

🟢200Success

application/json

Body

access_token

string

required

Short-lived token

refresh_token

string

required

Long-lived token

access_expire_at

string

required

Access token expiration time

refresh_expire_at

string

required

Refresh token expiration time

Example

{
  "access_token": "string",
  "refresh_token": "string",
  "access_expire_at": "2024-10-02T10:52:21.000000Z",
  "refresh_expire_at": "2024-10-25T10:52:21.000000Z"
}

Overview

Refresh token