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

# zelle/withdraw

`POST /zelle/withdraw`

## Request

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

Initiate a Zelle B2C payment to a recipient identified by email address or mobile phone number. Zelle is available to United States accounts only; a request from an account registered in any other country is rejected.

## 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
  - `FirstName` string: Recipient's first name. Required unless the recipient is resolved another way: supply a ZelleToken, or supply a ClientAccountID with a default Zelle recipient configured. In both of those cases the details are taken from the stored recipient and this must be omitted.
  - `LastName` string: Recipient's last name. Required unless the recipient is resolved another way: supply a ZelleToken, or supply a ClientAccountID with a default Zelle recipient configured. In both of those cases the details are taken from the stored recipient and this must be omitted.
  - `Amount` string, required: Payment amount in USD
  - `EmailAddress` string: Recipient's email address used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided, unless the recipient is resolved from a ZelleToken or from a ClientAccountID's default Zelle recipient.
  - `PhoneNumber` string: Recipient's mobile phone number used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided, unless the recipient is resolved from a ZelleToken or from a ClientAccountID's default Zelle recipient.
  - `PriorityType` string: Payment priority. Accepted values: STANDARD, INSTANT. Defaults to the account's configured priority type.
  - `Notes` string: Optional memo or note for the payment
  - `ClientAccountID` string: Client Account ID to associate with this transaction. When supplied with no recipient details and no ZelleToken, the client account's default Zelle recipient (set via zelle/set-my-recipient) is used; if that client account has no default recipient the request fails. If your account uses contacts (client accounts disabled), the contact's default Zelle recipient is always used and supplying a ZelleToken, EmailAddress or PhoneNumber alongside ContactID is rejected. If your account uses client accounts, the same restriction applies unless third-party client account transactions are enabled, in which case a client account may pay a named recipient — supplying a ZelleToken, EmailAddress or PhoneNumber alongside ClientAccountID is rejected.
  - `ClientReferenceNumber` string: An optional reference number to associate with this transaction
  - `IdempotencyKey` string: A unique key to prevent duplicate transactions
  - `GLCode` string: General ledger code for the transaction
  - `TransactionTypeCode` string: Custom transaction type code
  - `ParentTransactionID` string: ID of a parent pre-funding transaction to link to this payment
  - `ZelleToken` string: Token of a previously stored Zelle recipient (from zelle/link-recipient or zelle/recipients). When supplied, FirstName, LastName, EmailAddress and PhoneNumber must be omitted — the recipient details are taken from the stored recipient.

## 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
  - `TransactionID` string, required: Unique identifier for the created Zelle transaction
  - `Flagged` string: Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

---

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