VOvopay
Zelle Endpoints

zelle/link-recipient

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

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

IframeKeystring required

The iFrame key identifying the client account context for this recipient

RecipientNamestring

Full name of the recipient. If omitted, it is built from FirstName and LastName.

FirstNamestring

Recipient's first name, used to build RecipientName when RecipientName is not supplied

LastNamestring

Recipient's last name, used to build RecipientName when RecipientName is not supplied

EmailAddressstring

Recipient's email address used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided.

PhoneNumberstring

Recipient's mobile phone number used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

ZelleTokenstring required

Token identifying the stored Zelle recipient

Example response

{
  "Success": true,
  "ZelleToken": "a1b2c3d4e5f6"
}

Changes

No recorded changes to this operation across all 1 revision of this API.