VOvopay
Recipient Contact Endpoints

gcm/recipient-contacts

Get a list of recipient contacts for the account.

get/gcm/recipient-contacts

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/gcm/recipient-contacts
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Limitstring

Limit of how many recipient contacts to return

AccountStatusboolean

If the account status is active or not

ClientAccountIDstring

The client account ID that the recipients belong to

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

ContactClientTypestring required

If the contact is a individual or business

RecipientContactIDstring required

Contains a description of the error if the request failed

FirstNamestring required

The first name of the recipient contact

LastNamestring required

The last name of the recipient contact

BusinessNamestring required

The business name of the recipient contact

EmailAddressstring required

The email address of the recipient contact

PhoneNumberstring required

The phone number of the recipient contact

IsFavoriteboolean required

If the recipient contact is a favorite

Addressstring required

The address of the recipient contact

Citystring required

The city of the address

PostalCodestring required

The postal code of the address

Provincestring required

The province of the address

Countrystring required

The country of the address

Nationalitystring required

The nationality

Example response

{
  "Success": true,
  "ContactClientType": "individual",
  "RecipientContactID": "test_recipient_contact",
  "FirstName": "first",
  "LastName": "last",
  "BusinessName": "business",
  "EmailAddress": "first.last@vopay.com",
  "PhoneNumber": "7783630779",
  "Address": "1234 Test St",
  "City": "Vancouver",
  "PostalCode": "V6G3G9",
  "Province": "British Colmbia",
  "Country": "CA",
  "Nationality": "Canada"
}

Changes

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