---
title: "zelle/link-recipient"
method: POST
path: "/zelle/link-recipient"
tags: ["Zelle Endpoints"]
---

# zelle/link-recipient

`POST /zelle/link-recipient`

## Request

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

Tokenize a Zelle recipient during an iFrame flow so it can later be referenced by token in zelle/withdraw.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `IframeKey` string, required: The iFrame key identifying the client account context for this recipient
  - `RecipientName` string: Full name of the recipient. If omitted, it is built from FirstName and LastName.
  - `FirstName` string: Recipient's first name, used to build RecipientName when RecipientName is not supplied
  - `LastName` string: Recipient's last name, used to build RecipientName when RecipientName is not supplied
  - `EmailAddress` string: Recipient's email address used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided.
  - `PhoneNumber` string: Recipient's mobile phone number used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided.

## 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
  - `ZelleToken` string, required: Token identifying the stored Zelle recipient

---

[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)