---
title: "Get recipients"
method: GET
path: "/api/v1/recipients"
tags: ["Recipients"]
---

# Get recipients

`GET /api/v1/recipients`

Retrieves all recipients sorted by the full name

## Query parameters

- `page_number` integer
- `page_size` integer
- `sort` 'name' | 'usage'

## Response `200`

OK

- ResponseRecipientsResponse
  - `data` ResponseRecipientResponse[], required — List of recipients that satisfy the query and paging criteria
    - `id` string, required — Unique identifier of the recipient
    - `payment_details` ResponseRecipientPaymentDetailsResponse[] — Payment details of the recipient
      - `ach` ResponseRecipientPaymentDetailsAch
        - `account_number` string, required — Account number of the recipient bank account
        - `bank_name` string — Name of the bank of the recipient
        - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
          - `city` string, required — City of the recipient's legal address
          - `country` string, required — Country of the recipient's legal address
          - `line1` string, required — Street address of the recipient's legal address
          - `line2` string — Additional street address information of the recipient's legal address
          - `state` string — State of the recipient's legal address
          - `zip_code` string, required — Postal code of the recipient's legal address
        - `routing_number` string, required — Routing number of the recipient bank account
      - `bi_fast` ResponseRecipientPaymentDetailsBiFast
        - `account_number` string — Account number of the recipient
        - `bank_code` string — Bank code
        - `bank_name` string — Name of the bank
        - `destination_country` string — Destination country code
        - `recipient_name` string — Name of the recipient
      - `card` ResponseRecipientPaymentDetailsCard
        - `card_id` string, required — Card id of the recipient
        - `card_pan_last` string, required — Last 4 digits of recipient's card number
      - `cross_chain_crypto` ResponseRecipientPaymentDetailsCrossChainCrypto
        - `address` string, required — Destination address for the cross-chain crypto transfer (non-EVM address formats are supported, e.g., Solana, Tron, Bitcoin)
        - `network` string, required — Network to use for the payment
        - `tag` string — Optional destination tag/memo (e.g., XRP destination tag, Stellar memo)
      - `crypto` ResponseRecipientPaymentDetailsCrypto
        - `address` string, required — Deprecated: still populated for backward compatibility, but consumers should read recipient_address — this field carries the recipient destination address, which is now exposed as recipient_address.
        - `network` string, required — Network to use for the payment
        - `recipient_address` string, required — RecipientAddress is the destination address of the recipient crypto wallet. Preferred field; address mirrors the same value for backward compatibility.
      - `currencies` string[], required — List of currencies that the recipient can accept
      - `faster_payment` ResponseRecipientPaymentDetailsFasterPayment
        - `account_number` string, required — Account number of the recipient bank account
        - `sort_code` string, required — Sort code of the recipient bank account
      - `fps_hk` ResponseRecipientPaymentDetailsFpsHk
        - `bank_code` string — Bank code
        - `fps_id` string — FPS ID of the recipient
        - `fps_id_type` string — Type of FPS ID (MOBILE, EMAIL, FPS_ID)
        - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
          - `city` string, required — City of the recipient's legal address
          - `country` string, required — Country of the recipient's legal address
          - `line1` string, required — Street address of the recipient's legal address
          - `line2` string — Additional street address information of the recipient's legal address
          - `state` string — State of the recipient's legal address
          - `zip_code` string, required — Postal code of the recipient's legal address
        - `recipient_name` string — Name of the recipient
      - `id` string, required — Unique identifier of the recipient details
      - `imps` ResponseRecipientPaymentDetailsImps
        - `account_number` string — Account number of the recipient
        - `bank_name` string — Name of the bank
        - `destination_country` string — Destination country code
        - `ifsc_code` string — IFSC code of the bank
        - `recipient_name` string — Name of the recipient
      - `instapay` ResponseRecipientPaymentDetailsInstapay
        - `account_number` string — Account number of the recipient
        - `bank_code` string — Bank code
        - `bank_name` string — Name of the bank
        - `destination_country` string — Destination country code
        - `recipient_name` string — Name of the recipient
      - `ipp` ResponseRecipientPaymentDetailsIpp
        - `bank_name` string — Name of the bank
        - `destination_country` string — Destination country code
        - `iban` string — IBAN of the recipient
        - `recipient_name` string — Name of the recipient
      - `nip` ResponseRecipientPaymentDetailsNip
        - `account_number` string — Account number of the recipient
        - `bank_code` string — Bank code
        - `bank_name` string — Name of the bank
        - `destination_country` string — Destination country code
        - `recipient_name` string — Name of the recipient
      - `pix` ResponseRecipientPaymentDetailsPix
        - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
          - `city` string, required — City of the recipient's legal address
          - `country` string, required — Country of the recipient's legal address
          - `line1` string, required — Street address of the recipient's legal address
          - `line2` string — Additional street address information of the recipient's legal address
          - `state` string — State of the recipient's legal address
          - `zip_code` string, required — Postal code of the recipient's legal address
        - `national_id_number` string — Recipient ID number (CPF or CNPJ)
        - `pix_key` string — PIX key of the recipient
        - `pix_key_type` string — Type of PIX key (CPF, CNPJ, EMAIL, PHONE, EVP)
        - `recipient_name` string — Name of the recipient
      - `pse` ResponseRecipientPaymentDetailsPse
        - `account_number` string — Account number of the recipient
        - `account_type` string — Account type (SAVINGS, CHECKING)
        - `bank_code` string — Bank code
        - `destination_country` string — Destination country code
        - `document_number` string — Document number
        - `document_type` string — Document type (CC, NIT, CE, PASSPORT)
        - `recipient_name` string — Name of the recipient
      - `sepa` ResponseRecipientPaymentDetailsSepa
        - `bic` string, required — BIC of the recipient bank account
        - `iban` string, required — IBAN of the recipient bank account
      - `spei` ResponseRecipientPaymentDetailsSpei
        - `clabe` string, required — CLABE of the recipient bank account
        - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
          - `city` string, required — City of the recipient's legal address
          - `country` string, required — Country of the recipient's legal address
          - `line1` string, required — Street address of the recipient's legal address
          - `line2` string — Additional street address information of the recipient's legal address
          - `state` string — State of the recipient's legal address
          - `zip_code` string, required — Postal code of the recipient's legal address
        - `national_id_number` string — Recipient ID number (CURP or RFC)
      - `swift` ResponseRecipientPaymentDetailsSwift
        - `bank_country` string — Bank country code (ISO 3166-1 alpha-2)
        - `bank_name` string — Bank name of the recipient
        - `bic` string, required — BIC of the recipient bank account
        - `iban` string, required — IBAN of the recipient bank account
        - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
          - `city` string, required — City of the recipient's legal address
          - `country` string, required — Country of the recipient's legal address
          - `line1` string, required — Street address of the recipient's legal address
          - `line2` string — Additional street address information of the recipient's legal address
          - `state` string — State of the recipient's legal address
          - `zip_code` string, required — Postal code of the recipient's legal address
      - `type` 'Crypto' | 'Sepa' | 'FasterPayment' | 'Ach' | 'Swift' | 'Spei' | 'Card' | 'Pix' | 'FpsHk' | 'Imps' | 'Instapay' | 'BiFast' | 'Nip' | 'Ipp' | 'Pse' | 'CrossChainCrypto', required
    - `personal_info` ResponseRecipientPersonalInfo, required
      - `company_name` string — Name of the company/business this recipient is for (<span style="color:red">WOULD</span> be provided if the recipient is a **business**)
      - `first_name` string — First name of the recipient (<span style="color:red">WOULD</span> be provided if the recipient is a **person**)
      - `is_business` boolean, required — Indicator of whether the recipient is a business
      - `last_name` string — Last name of the recipient (<span style="color:red">WOULD</span> be provided if the recipient is a **person**)
      - `nick_name` string — Optional nickname for the recipient

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.dev/wirexapp/apis/wirex-baas-api.md) · [All operations](https://skmtc.dev/wirexapp/apis/wirex-baas-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wirexapp/wirex-baas-api/revisions/b95a180790b1/schema)