Get agents - Freedom Pay

Request

Header Params

Authorization

string

required

Example:

Bearer <access_token>

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.freedompay.kz/v5/partner/transfer/agent/list' \
--header 'Authorization:  Bearer <access_token>'

Responses

🟢200Success

application/json

Body

agents

array [object {9}]

required

id

string <uuid>

required

Unique agent identifier

<= 36 characters

name

string

required

Agent name

<= 100 characters

currency

string

required

Agent currency code.
(ISO 3166-1 alpha-3)

<= 3 characters

phone

string

required

Agent support contact number

<= 20 characters

code

string

required

Internal agent code.
(alpha-3)

<= 3 characters

country

string

required

Agent country code
(ISO 3166-1 alpha-3)

<= 3 characters

transfer_type

array[string]

required

Allowed values:

NMBCNT

address

array [object {3}]

required

Agent address

response_time

string

required

Date and time of response generation.

Example

{
  "agents": [
    { 
      "id": "abcd-1234-efgh-5678", 
      "name": "Agent A", 
      "currency": "KZT",
      "phone": "+77070000001"
      "code": "NBK", 
      "country": "KAZ", 
      "transfer_type": ["NMB", "CNT"],
      "address": [
    "city": "Алматы",
    "street": "Абая",
    "postcode": "050000"
]
  },
  {
      "id": "abcd-1234-efgh-8765", 
      "name": "Agent B", 
      "currency": "UZB", 
      "phone": "+77070000000"
      "code": "NBK", 
      "country": "UZB", 
      "transfer_type": ["CNTR"],
      "address": [
    "city": "Ташкент",
    "street": "Зиёлилар",
    "postcode": "100085"
      }
    }
  ],
  "response_time": "2025-03-31T10:35:21.000Z"
}