Get agents - Freedom Pay

Request

Header Params

Authorization

string

required

Example:

Bearer <access_token>

Body Params application/json

signature

string

required

Request signature.

<= 512 characters

Example

{
    "signature": "{{sign}}"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v5/partner/transfer/agent/list' \
--header 'Authorization:  Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "signature": "{{sign}}"
}'

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

{
  "state": true,
  "response_time": "2025-06-26T13:42:19.344540Z",
  "payload": {
    "agents": [
      {
        "id": 1,
        "name": "McGlynn-Kunde",
        "currency": "KGS",
        "code": "PQKDVD",
        "country": "KGZ",
        "transfer_type": [
          "PC582"
        ],
        "address": {
          "city": "East Brandtshire",
          "street": "17852 Mraz Shores Apt. 090",
          "postcode": "17011"
        }
      },
      {
        "id": 2,
        "name": "Padberg, Auer and Mayert",
        "currency": "KGS",
        "code": "K5W5SI",
        "country": "KGZ",
        "transfer_type": [
          "PC508"
        ],
        "address": {
          "city": "Arielville",
          "street": "707 King View",
          "postcode": "39256-1018"
        }
      },
      {
        "id": 3,
        "name": "Wisozk LLC",
        "currency": "KGS",
        "code": "OV8RHC",
        "country": "KGZ",
        "transfer_type": [
          "PC251"
        ],
        "address": {
          "city": "Caspertown",
          "street": "1201 Fahey View Apt. 669",
          "postcode": "07886"
        }
      },
      {
        "id": 4,
        "name": "Treutel Inc",
        "currency": "AED",
        "code": "ASIAU8",
        "country": "ARE",
        "transfer_type": [
          "PC579",
          "PC582",
          "PC007"
        ],
        "address": {
          "city": "West Jalon",
          "street": "906 Daisy Courts",
          "postcode": "39051-4180"
        }
      },
      {
        "id": 5,
        "name": "Schimmel-Littel",
        "currency": "KGS",
        "code": "MZDE3W",
        "country": "KGZ",
        "transfer_type": [
          "PC114",
          "PC579",
          "PC417"
        ],
        "address": {
          "city": "Gisselleside",
          "street": "1764 Schultz Ramp Suite 300",
          "postcode": "47540-0296"
        }
      }
    ]
  },
  "signature": "74bad1f6fc2e17d9a613e04080c510fde1d152cd7d82a94c4bf83abbaab44ee0"
}