---
title: "List Recipients"
method: GET
path: "/recipients"
---

# List Recipients

`GET /recipients`

## Query parameters

- `limit` integer
- `offset` integer
- `national_entity` 'INDIVIDUAL' | 'ENTITY'
- `country` string

## Response `200`

List of recipients retrieved successfully

- object
  - `data` RecipientResponse[]
    - `id` string — The unique identifier of the recipient.
    - `account_id` string — The account identifier associated with this recipient.
    - `merchant_recipient_id` string — Unique identifier of the recipient defined by the merchant.
    - `national_entity` string — Beneficiary's national entity type.
    - `entity_type` string — Beneficiary's type of organization.
    - `first_name` string — Beneficiary's name.
    - `last_name` string — Beneficiary's last name.
    - `legal_name` unknown
    - `email` string — The Beneficiary's email.
    - `date_of_birth` string — Beneficiary's date of birth.
    - `country` string — The Beneficiary's country.
    - `website` string — The seller's website URL.
    - `industry` string — The seller's industry.
    - `merchant_category_code` string — The merchant category code (MCC) (MAX 235; MIN 1).
    - `document` object
      - `document_number` string
      - `document_type` string
    - `phone` object
      - `country_code` string
      - `number` string
    - `address` object
      - `address_line_1` string
      - `address_line_2` string
      - `city` string
      - `country` string
      - `state` string
      - `zip_code` string
      - `neighborhood` string
    - `legal_representatives` object[]
      - `merchant_reference` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `date_of_birth` string
      - `country` string
      - `nationality` string
      - `title` string
      - `publicly_exposed_person` boolean
      - `ultimate_beneficial_owner` boolean
      - `document` object
        - `document_type` string
        - `document_number` string
      - `phone` object
        - `country_code` string
        - `number` string
      - `address` object
        - `address_line_1` string
        - `address_line_2` unknown
        - `country` string
        - `state` string
        - `city` string
        - `zip_code` string
    - `withdrawal_methods` object
      - `bank` object
        - `code` string
        - `branch` string
        - `branch_digit` string
        - `account` string
        - `account_digit` string
        - `account_type` string
        - `routing` string
        - `country` string
        - `currency` string
    - `documentation` object[]
      - `file_name` string
      - `content_type` string
      - `content_category` string
      - `content` string
    - `onboardings` object[]
      - `id` string
      - `type` string
      - `workflow` string
      - `status` string
      - `callback_url` string
      - `provider` object
        - `id` string
        - `connection_id` string
        - `recipient_id` unknown
        - `redirect_url` unknown
        - `onboarding_url` unknown
        - `legal_entity` unknown
        - `balance_account_id` unknown
        - `legal_entity_id` unknown
      - `documentation` object[]
        - `file_name` string
        - `content_type` string
        - `content_category` string
        - `content` string
      - `legal_representatives` object[]
      - `requirements` object[]
        - `field` string
        - `message` string
        - `status` string
      - `withdrawal_methods` object
        - `bank` object
          - `code` string
          - `branch` string
          - `branch_digit` unknown
          - `account` string
          - `account_digit` unknown
          - `account_type` string
          - `routing` string
          - `country` string
          - `currency` string
      - `terms_of_service` object
        - `acceptance` boolean
        - `date` string
        - `ip` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `split_configuration` object — Rules for automatic split calculation at the recipient level.
      - `calculation_type` 'PERCENTAGE' | 'FIXED' | 'MIXED' — The method used to calculate the split amount.
      - `percentage` number — Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED.
      - `fixed_amount` number — Fixed amount to be split. Required if calculation_type is FIXED or MIXED.
      - `currency` string — ISO 4217 currency code. Required for all calculation types.
      - `rounding_mode` 'STANDARD' | 'ROUND_UP' | 'ROUND_DOWN' — The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED.
    - `created_at` string, date-time — Recipient creation date (ISO 8601 MAX 27; MIN 27).
    - `updated_at` string, date-time — Last Recipient updated date (ISO 8601 MAX 27; MIN 27).
  - `pagination` object
    - `total` integer — Total number of recipients
    - `limit` integer — Number of recipients per page
    - `offset` integer — Current offset
    - `has_more` boolean — Whether there are more recipients to fetch

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/y/apis/ai-caller.md) · [All operations](https://skmtc.net/y/apis/ai-caller/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/y/ai-caller/revisions/05b629819b49/schema)