v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Recipient Contact Endpoints

gcm/recipient-contacts

Get a list of recipient contacts for the account.

get/gcm/recipient-contacts

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

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

ContactClientTypestring

If the contact is a individual or business

RecipientContactIDstring

Contains a description of the error if the request failed

FirstNamestring

The first name of the recipient contact

LastNamestring

The last name of the recipient contact

BusinessNamestring

The business name of the recipient contact

EmailAddressstring

The email address of the recipient contact

PhoneNumberstring

The phone number of the recipient contact

IsFavoriteboolean

If the recipient contact is a favorite

Addressstring

The address of the recipient contact

Citystring

The city of the address

PostalCodestring

The postal code of the address

Provincestring

The province of the address

Countrystring

The country of the address

Nationalitystring

The nationality

Example response

{
  "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"
}