Freedom Pay
  1. OAuth2
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Overview
        • Card
        • IBAN
        • Balance
        • Status
      • Transfer
        • Overview
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Overview
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Overview
        • Token Pay
        • Apple Pay
        • Google Pay
        • Token Payout
        • Status
    • Async API
      • Overview
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Overview
    • Purchase
      • Overview
      • Checkout
      • Card token
        • Overview
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment (with CVC)
        • Confirm payment (with CVC)
        • Create payment
        • Confirm payment
      • Create payment
      • Any amount
      • Cancel payment
      • Clearing
      • Refund payment
      • Status
    • Payout
      • Overview
      • Card token
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment
      • Create payment
      • IBAN
      • Balance status
      • Status by order_id
      • Status by Payment ID
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Init
      • Info
      • Pay
      • Status
    • SDK
      • JS SDK
      • Google Pay
      • Freedom QR
        • Reader SDK (Android)
        • Provider SDK (Android)
      • Payment SDK
        • iOS
        • Android
    • CMS
      • Overview
      • Get Merchant ID and key
      • WordPress
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
        • Update
      • Tilda
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • InSales
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Ecwid
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Bitrix
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • PrestaShop
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • OpenCart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Dictionaries
      • Bulk issue
      • Issue card
      • Issue plastic card
      • Activate card
      • Block card
      • Unblock card
      • Set PIN
      • Reset PIN counter
      • Close card
      • Update client
      • Card info
      • Balance
      • Secret data
      • Secret data (version 2)
      • Statement
      • Statement extended
      • Create client
      • Edit client
      • Сards' list
      • Request' status
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction request' status
      • Transaction info
    • Gift Cards
      • Overview
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Overview
      • Design
      • iOS SDK
      • Android SDK
      • OAuth2
        • Authorization link
          POST
        • Token exchange
          POST
        • Token refresh
          PATCH
        • User info
          GET
        • Request profile
          POST
        • Get profile status
          GET
        • Create user
          POST
        • Update user
          PUT
      • OIDC
        • Authorization endpoint
        • Token exchange
        • Userinfo
      • Error codes
      • Examples
        • Keycloak
    • Transfer
      • Overview
      • Get token
      • Refresh token
      • Get agents
      • Fees
      • Create person
      • Create business
      • Create transfer
      • Print application
      • Confirm
      • Search
      • Payout
      • Payout confirm
      • Cancel
      • Get person info
      • Get business info
      • Status
      • Info
    • Device ID
      • Android SDK
      • iOS SDK
  1. OAuth2

Token refresh

PATCH
https://passport.freedompay.kz/api/v1/oauth/token
This method is used to refresh an expired access_token using a refresh_token.
If the access_token has expired, the application can use the refresh_token to request a new set of tokens.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://passport.freedompay.kz/api/v1/oauth/token'

Responses

🟢200Success
application/json
Body
id
string <uuid>
required
Access token unique identifier (UUID)
access_token
string <[a-zA-Z0-9]{128}>
required
Access token used for authentication in requests to protected resources. The token is valid for 7 days from the request date. In subsequent requests in FID, this field is referred to as client_access_token.
refresh_token
string <[a-zA-Z0-9]{128}>
required
Refresh token used to obtain a new access token. The token is valid for 1 month from the request date.
access_expire_at
string <Datetime:ISO-8601>
required
Expiration time of the access token
refresh_expire_at
string <Datetime:ISO-8601>
required
Expiration time of the refresh token
Example
{
  "id": "01953bd1-a6d3-739e-8aa3-83e881f09055",
  "access_token": "2gcd8ucjoyay6MCpFYwjx0XJz7kxrUOcPRtEEFbPh3UjFfOT6kqC2Emssi9XDKF9bk9BrHz6vqoKX1Ig82gsBf89xeWJ339gaRGYbYNLP59JQBsUz0G8yMv8Re8vR5Eh",
  "refresh_token": "atH8ha6yqPJUOiRqyAuDbkPuDUKRqgsUJmIkJQoAI6T36SaTs4Af9pBy8XxuxiOShAB91taqmEmPiVXf3MP8lTqSs9EawvqdbAGx7xW5BZTaFZjRpoAyQWXttwUbPZgQ",
  "access_expire_at": "2025-03-04T06:35:50.000000Z",
  "refresh_expire_at": "2025-03-25T06:35:50.000000Z"
}
Previous
Token exchange
Next
User info