VOvopay
Recipient Contact Endpoints

gcm/recipient-contacts/add

Add a recipient contact. All name, address, and phone fields must comply with Mastercard Cross-Border Services Data Quality Standards (effective April 20, 2026).

post/gcm/recipient-contacts/add

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/gcm/recipient-contacts/add
  • 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

EmailAddressstring required

The email address of the recipient contact

ContactClientTypestring required

If the contact is an individual or business

ClientAccountIDstring

The client account ID the recipient belongs to

RecipientContactIDstring

The ID for the recipient contact

BusinessNamestring

Full legal business name of the recipient. Required if FirstName and LastName are not provided. Must be 2-60 characters and contain at least one letter. No abbreviations except standard suffixes (e.g. LLC, Ltd.).

FirstNamestring

First name of the individual recipient. Required if BusinessName is not provided. Must be 2-60 characters using only letters, spaces, commas, apostrophes, hyphens, and dots. No initials, acronyms, or company identifiers.

LastNamestring

Last name of the individual recipient. Required if BusinessName is not provided. Must be 2-60 characters using only letters, spaces, commas, apostrophes, hyphens, and dots. No initials, acronyms, or company identifiers.

PhoneNumberstring required

Phone number of the recipient. Digits only, 9-15 characters. No spaces or hyphens (e.g. 19998887777).

Address1string required

Street address of the recipient. Must include a street name (e.g. 20 Longleat Drive). Numbers only are not accepted.

Address2string

The second address line of the recipient contact

Citystring required

City of the recipient's address.

Provincestring

The province of the address

PostalCodestring

The postal code of the address

Countrystring

Country of the recipient's address. Accepts full country name or ISO 3166-1 alpha-2 or alpha-3 code. Sanctioned countries are not accepted.

DateOfBirthstring

Date of birth of the recipient in YYYY-MM-DD format (e.g. 1990-01-31).

Nationalitystring

The nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

Languagestring

The language preference

SourceOfIncomestring

The source of income of the recipient contact

Occupationstring

The occupation of the recipient contact

RelationshipWithBeneficiarystring

The sender's relationship to the recipient contact

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

RecipientContactIDinteger required

The unique ID of the new recipient contact.

Example response

{
  "Success": true
}

Changes

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