Freedom Pay
  1. Transfer
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
    • Result notify
    • Payout notify
    • Check request
  • 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
        • Token exchange
        • Token refresh
        • User info
        • Request profile
        • Get profile status
        • Create user
        • Update user
      • OIDC
        • Authorization endpoint
        • Token exchange
        • Userinfo
      • Error codes
      • Examples
        • Keycloak
    • Transfer
      • Overview
      • Get token
        POST
      • Refresh token
        PATCH
      • Get agents
        GET
      • Fees
        POST
      • Create person
        POST
      • Create business
        POST
      • Create transfer
        POST
      • Print application
        POST
      • Confirm
        POST
      • Search
        POST
      • Payout
        POST
      • Payout confirm
        POST
      • Cancel
        POST
      • Get person info
        POST
      • Get business info
        POST
      • Status
        GET
      • Info
        GET
    • Device ID
      • Android SDK
      • iOS SDK
  1. Transfer

Fees

POST
https://api.freedompay.kz/v5/partner/transfer/fees
Performs a preliminary calculation of the commission for a transfer.
The fee depends on the sender type, destination country, transfer amount, and currencies involved.
This method is used to show the client the total transfer cost before initiating the transaction.

Request

Header Params
Authorization
string 
required
Example:
Bearer <access_token>
Body Params application/json
originator_type
enum<string> 
required
Originator type.
<= 10 characters
Allowed values:
personbusiness
target_country
string 
required
Transfer target country code.
(ISO 3166-1 alpha-3)
<= 3 characters
amount_source
number 
required
Soursce transfer amount.
<= 15.4
currency_source
string 
required
Source currency code.
(ISO 3166-1 alpha-3)
<= 3 characters
currency_target
string 
required
Target currency code.
(ISO 3166-1 alpha-3)
<= 3 characters
pg_sig
string 
required
Request signature.
<= 512 characters
Example
{
  "payload": {
    "originator_type": "person",
    "target_country": "KAZ",
    "amount_source": 100,
    "currency_source": "KZT",
    "currency_target": "UZB"
  },
  "pg_sig": "5a1d5f17e4c1f5a3b44c3f29b5e2d77cd11b1b5fefc3dcb5b1c2f8e73f9c22a1"
}

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 POST 'https://api.freedompay.kz/v5/partner/transfer/fees' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payload": {
        "originator_type": "person",
        "target_country": "KAZ",
        "amount_source": 100,
        "currency_source": "KZT",
        "currency_target": "UZB"
    },
    "pg_sig": "5a1d5f17e4c1f5a3b44c3f29b5e2d77cd11b1b5fefc3dcb5b1c2f8e73f9c22a1"
}'

Responses

🟢200Success
application/json
Body
amount_target
number 
required
Target transfer amount.
<= 15.4
currency_target
string 
required
Target currency code.
(ISO 3166-1 alpha-3)
<= 3 characters
rate
number 
required
Exchange rate
<= 10.8
total_fee
number 
required
The total commission on top of the transfer that will be debited from the client
<= 10.4
agent_fee
number 
required
Agent commission
<= 10.4
response_time
string 
required
Date and time of response generation.
Example
{
  "amount_target": 105,
  "currency_target": "UZB",
  "rate": "2.5",
  "total_fee": 5,
  "agent_fee": 1.5,
  "response_time": "2025-03-31T10:35:21.000Z"
}
Previous
Get agents
Next
Create person