Create transfer - Freedom Pay

This method is used to create new requests for transfer funds.
When using this method, the fees are updated again and the transfer is registered in the system.

On-Demand Transfers:
Initiates the transfer, necessarily specifying:
{destination_type} = {phone}
{destination_identifier} = recipient's phone number.
The {agent_id} parameter is not transmitted. The absence of this parameter signals the system that the transfer is a "On Demand" transfer.

Phone-Based Transfers:
Initiates the transfer by specifying:
{destination_type} = an available value depending on the goals and objectives
in {destination_identifier} = Value for the receiving method, for example iban.

The {agent_id} parameter must be present in the request, which identifies the target receiving agent.

The IMTS uses {agent_id} to direct the transfer specifically to the specified financial institution or agent.

Request

Header Params

Authorization

string

required

Example:

Bearer <access_token>

Body Params application/json

client_uuid

string <uuid>

required

Unique client identifier.

<= 36 characters

destination_type

enum<string>

required

Method of receipt.

<= 20 characters

Allowed values:

phoneibanpan

destination_identifier

string

required

Meaning for the method of receipt.

<= 100 characters

target_agent_id

string

optional

Target agent identifier.

<= 36 characters

target_country

string

required

Transfer target country code.
(ISO 3166-1 alpha-3)

<= 3 characters

amount_source

number

required

Transfer source amount.

<= 15.4

currency_source

string

required

Sourcecurrency 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": {
    "client_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "destination_type": "phone",
    "destination_identifier": "+77076367701",
    "target_agent_id": "abcd-1234-efgh-5678",
    "target_country": "KAZ",
    "amount_source": 100,
    "currency_source": "KZT",
    "currency_target": "UZB"
  },
  "pg_sig": "5a1d5f17e4c1f5a3b44c3f29b5e2d77cd11b1b5fefc3dcb5b1c2f8e73f9c22a1"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

transfer_uuid

string

required

Unique identifier of the created transfer.

<= 36 characters

status

string

required

Current status of the transfer.

<= 10 characters

amount_target

number

required

Transfer amount in target currency.

<= 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

{
  "transfer_uuid": "b84c2a19-b99b-470e-82e2-54785f67a9b3",
  "status": "new",
  "amount_target": 105,
  "currency_target": "UZB",
  "rate": "2.5",
  "total_fee": 5,
  "agent_fee": 1.5,
  "response_time": "2025-03-31T10:35:21.000Z"
}