> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ledig.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List your recipients

> View saved payment recipients and their review status.

**Required scope:** `recipient_read`

Use limit, cursor and sort to page through your recipients. limit must be a positive integer; values above 100 are accepted and capped at 100. Follow pagination.nextCursor to retrieve the next page.


## OpenAPI

````yaml /openapi/public.yaml get /v1/recipients
openapi: 3.1.0
info:
  title: Ledig payments API
  version: 0.1.0
  description: >-
    Use the Ledig payments engine to receive funds, view balances, convert
    currencies and send payments.


    Choose Sandbox to test your integration or Live for production payments.
    Each endpoint explains the fields, permissions and errors you need to
    handle.


    Sign API requests with your business API key and HMAC-SHA256. Endpoints
    listing BearerAuth also accept a user access token. Follow
    https://docs.ledig.io/auth/authentication to sign your requests.
  contact:
    name: Ledig
    email: support@ledig.io
    url: https://docs.ledig.io
servers:
  - url: https://api-sandbox.ledig.io
    description: Sandbox
  - url: https://api.ledig.io
    description: Live
security:
  - LedigApiKey: []
    LedigTimestamp: []
    LedigSignature: []
tags:
  - name: Managed businesses
    description: Onboarding for businesses you manage.
  - name: System
    description: Health and availability.
  - name: Balances
    description: Your available and reserved funds by currency.
  - name: Currencies and rates
    description: Supported currencies, networks and indicative rates.
  - name: Funding accounts
    description: Fiat accounts that receive customer deposits.
  - name: Deposit wallets
    description: Crypto addresses that receive customer deposits.
  - name: Recipients
    description: Saved payout destinations.
  - name: Ledig businesses
    description: Find a business before paying through the Ledig network.
  - name: Payment options
    description: Available payout methods, fees and limits.
  - name: Quotes
    description: Confirm rates, fees and amounts before sending.
  - name: Transfers
    description: Start and track conversions and payments.
  - name: Transactions
    description: Customer transaction history.
paths:
  /v1/recipients:
    get:
      tags:
        - Recipients
      summary: List your recipients
      description: View saved payment recipients and their review status.
      operationId: listRecipients
      parameters:
        - in: query
          name: limit
          description: >-
            Positive integer page size. Values greater than 100 are accepted and
            capped at 100; follow pagination.nextCursor for more results.
          schema:
            type: integer
            minimum: 1
            default: 20
          example: 20
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: Recipient page.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CursorPage'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/ClientRecipient'
              example:
                status: success
                data:
                  - id: recipient_example_001
                    profileId: profile_example_001
                    recipientRequirementId: crypto_address
                    fields:
                      network: ETHEREUM_SEPOLIA
                      address: '0x1111111111111111111111111111111111111111'
                      accountName: Example Treasury
                    destinationScope:
                      network: ETHEREUM_SEPOLIA
                      assets:
                        - USDC
                    is3rdParty: true
                    oneTime: false
                    deletedAt: null
                    active: true
                    object: recipients
                    fieldsDetail:
                      - name: address
                        displayName: Wallet address
                        value: '0x1111111111111111111111111111111111111111'
                        required: true
                        visible: true
                        copyable: true
                      - name: accountName
                        displayName: Account Name
                        value: Example Treasury
                        required: true
                        visible: true
                        copyable: true
                    createdAt: '2026-01-15T10:00:00.000Z'
                    updatedAt: '2026-01-15T10:00:00.000Z'
                    reviewStatus: approved
                    usableForPayout: true
                    payoutReadiness: checks_required
                pagination: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: >-
            import { createHmac } from "node:crypto";


            // Node.js 18+. Set credentials and resource values on your server.

            function required(name) {
              const value = process.env[name];
              if (!value) throw new Error(`Set ${name} before running this example.`);
              return value;
            }


            const baseUrl = process.env.LEDIG_API_BASE_URL ??
            "https://api-sandbox.ledig.io";

            const method = "GET";

            const path = `/v1/recipients`;

            const pathWithQuery = path;

            const rawBody = "";

            const headers = { "Accept": "application/json" };

            const timestamp = Math.floor(Date.now() / 1000).toString();

            const payload =
            `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;

            headers["x-ledig-key"] = required("LEDIG_API_KEY");

            headers["x-ledig-timestamp"] = timestamp;

            headers["x-ledig-signature"] = "v1=" + createHmac("sha256",
            required("LEDIG_API_SECRET"))
              .update(payload).digest("base64");

            const response = await fetch(`${baseUrl}${pathWithQuery}`, {
              method,
              headers,
            });

            const result = await response.json();

            // Use result in your application; do not log credentials or upload
            links.

            console.log(response.status);
components:
  parameters:
    Cursor:
      in: query
      name: cursor
      schema:
        type: string
      example: eyJpZCI6InRyYW5zYWN0aW9uX2V4YW1wbGVfMDAxIn0
    Sort:
      in: query
      name: sort
      schema:
        type: string
        enum:
          - asc
          - desc
      example: desc
  schemas:
    CursorPage:
      allOf:
        - $ref: '#/components/schemas/Success'
        - type: object
          required:
            - data
            - pagination
          properties:
            pagination:
              type: object
              properties:
                nextCursor:
                  type: string
                previousCursor:
                  type: string
    ClientRecipient:
      type: object
      additionalProperties: false
      description: >-
        A saved payment destination with its review status and payment
        eligibility.
      required:
        - id
        - profileId
        - recipientRequirementId
        - fields
        - is3rdParty
        - oneTime
        - deletedAt
        - active
        - object
        - fieldsDetail
        - createdAt
        - updatedAt
        - reviewStatus
        - usableForPayout
        - payoutReadiness
      properties:
        id:
          type: string
        profileId:
          type: string
        recipientRequirementId:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        requirement:
          type:
            - object
            - 'null'
          additionalProperties: false
          required:
            - name
            - category
            - type
            - currencies
          properties:
            name:
              type: string
            category:
              type: string
            type:
              type: string
            currencies:
              type: array
              items:
                type: string
        fields:
          type: object
          additionalProperties:
            type: string
          description: >-
            Your saved destination details. The accepted fields depend on the
            recipient type.
        destinationScope:
          type: object
          additionalProperties: false
          required:
            - network
          properties:
            network:
              type: string
            assets:
              type: array
              items:
                type: string
        legalEntityType:
          type: string
          enum:
            - individual
            - business
        bankDetailsSource:
          type: string
          enum:
            - directory
            - manual
        is3rdParty:
          type: boolean
        oneTime:
          type: boolean
        active:
          type: boolean
        deletedAt:
          type:
            - string
            - 'null'
        object:
          type: string
          const: recipients
        fieldsDetail:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - name
              - displayName
              - value
              - required
              - visible
              - copyable
            properties:
              name:
                type: string
              displayName:
                type: string
              value:
                type: string
              required:
                type: boolean
              visible:
                type: boolean
              copyable:
                type: boolean
        reviewStatus:
          type: string
          enum:
            - pending
            - approved
            - rejected
            - revoked
        usableForPayout:
          type: boolean
          description: >-
            Whether this destination can currently be selected for a payout.
            This is a selection hint, not approval to send; read payoutReadiness
            and check the quote and transfer results.
        payoutReadiness:
          type: string
          enum:
            - unavailable
            - review_refresh_required
            - review_pending
            - checks_required
          description: >-
            The recipient's saved state: unavailable, review_pending,
            review_refresh_required or checks_required. checks_required still
            needs current quote and payment checks; none of these values
            guarantees a payment can proceed.
    Success:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          const: success
        message:
          type: string
    Error:
      type: object
      required:
        - status
        - message
        - code
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        code:
          type: string
        details:
          description: >-
            Additional information to help resolve an error, such as a file
            problem, allowed amount range or remaining payment allowance. The
            fields depend on the error code.
          oneOf:
            - type: object
              additionalProperties: false
              description: >-
                File-validation details returned with HTTP 400, 413 or 422
                BAD_REQUEST.
              required:
                - validationCode
                - reasonCode
                - retryable
              properties:
                validationCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                reasonCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                retryable:
                  type: boolean
                  const: false
                documentId:
                  type: string
                  maxLength: 128
                requirementType:
                  type: string
                maxSizeBytes:
                  type: integer
                  minimum: 1
                  maximum: 1073741824
                  description: >-
                    Maximum accepted file size in bytes, when supplied with HTTP
                    413.
            - type: object
              additionalProperties: false
              required:
                - reason
              properties:
                reason:
                  type: string
                  enum:
                    - current_password_incorrect
                    - unsupported_asset_network
                    - recipient_unavailable
                    - recipient_incompatible
                    - payout_method_unavailable
                    - payout_method_incompatible
                    - network_unavailable
                    - quote_expired
                    - quote_already_used
                    - quote_changed
                    - invoice_required
                    - invoice_invalid
                    - amount_invalid
                    - amount_precision_invalid
                    - onboarding_revision_required
                    - onboarding_revision_changed
                    - onboarding_document_kind_mismatch
                precision:
                  type: integer
                  minimum: 0
                  maximum: 18
                  description: >-
                    Allowed number of decimal places when reason is
                    amount_precision_invalid.
            - type: object
              additionalProperties: false
              required:
                - period
                - sourceCurrency
                - requested
                - remaining
                - limit
                - resetsAt
                - timezone
              properties:
                period:
                  type: string
                  enum:
                    - daily
                    - monthly
                sourceCurrency:
                  type: string
                  pattern: ^[A-Z][A-Z0-9]{1,19}$
                requested:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                remaining:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                limit:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
            - type: object
              additionalProperties: false
              required:
                - sourceCurrency
                - minimumAmount
                - maximumAmount
              properties:
                sourceCurrency:
                  type: string
                minimumAmount:
                  type: string
                maximumAmount:
                  type: string
              description: >-
                Returned with HTTP 422 RATE_ROUTE_AMOUNT_OUT_OF_RANGE. These
                limits apply to the amount being converted, in the source
                currency.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - limitUsd
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                limitUsd:
                  type: string
              description: >-
                Returned with HTTP 422 PAYOUT_TRANSACTION_LIMIT_EXCEEDED. This
                per-payment limit uses USD equivalent and is separate from the
                payout method's currency limits.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - remainingUsd
                - resetsAt
                - timezone
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                remainingUsd:
                  type: string
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
              description: >-
                Returned with HTTP 422 PAYOUT_MONTHLY_LIMIT_EXCEEDED. Shows your
                business's remaining monthly allowance and when it resets.
  responses:
    Unauthorized:
      description: >-
        Authentication is missing, invalid or expired. Check your credentials
        and request signature.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: UNAUTHORIZED
            message: Authentication is required.
    Forbidden:
      description: >-
        Your account is inactive, the business selection is missing, or your
        credentials do not have the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: FORBIDDEN
            message: You do not have permission to perform this action.
    RateLimited:
      description: >-
        A request or operation allowance has been reached. Wait before retrying.
        If the endpoint uses an idempotency key, keep the same key for the
        retry.
      headers:
        Retry-After:
          description: The number of seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
        Cache-Control:
          description: >-
            Responses use private, no-store or no-store. Do not cache this
            response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: RATE_LIMITED
            message: Too many requests. Wait before trying again.
  securitySchemes:
    LedigApiKey:
      type: apiKey
      in: header
      name: x-ledig-key
      description: >-
        Your business API key ID. Keep its secret on your server and use that
        secret to sign each request.
    LedigTimestamp:
      type: apiKey
      in: header
      name: x-ledig-timestamp
      description: The current Unix timestamp in seconds, used in the signed request.
    LedigSignature:
      type: apiKey
      in: header
      name: x-ledig-signature
      description: >-
        The request's HMAC-SHA256 signature. Use the v1= prefix for supported
        own-business requests, or v2= when acting for a managed business with
        signed business-selection headers. Follow the authentication guide to
        construct and sign the exact request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.