---
title: "zelle/recipients"
method: GET
path: "/zelle/recipients"
tags: ["Zelle Endpoints"]
---

# zelle/recipients

`GET /zelle/recipients`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/zelle/recipients`
- Auth: none declared

List saved Zelle recipients for the account. Recipients are automatically saved when a Zelle payment is submitted.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `NumberOfRecords` integer, required: Total number of recipients returned
  - `Recipients` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of saved Zelle recipients
    - `0` object
      - `RecipientName` string, required: Full name of the recipient
      - `AliasType` string, required: Type of Zelle alias. Possible values: EMAIL, MOBILE
      - `AliasValue` string, required: The recipient's Zelle alias (email address or phone number)
      - `ZelleToken` string, nullable, required: Token identifying the stored recipient, usable with zelle/withdraw, zelle/delete and zelle/set-my-recipient. Null for recipients created before tokenization was introduced; such a recipient is issued a token the next time it is used or re-linked.
      - `IsDefault` boolean, required: Whether this recipient is the default for its scope

---

[API](https://skmtc.dev/vopay/apis/payment-methods.md) - [All operations](https://skmtc.dev/vopay/apis/payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-methods/revisions/b566c8002410?raw)