Contacts

Retrieve contact

Changed on

Use this method to retrieve details about a contact.

To retrieve a contact, you need its contactId. Our gateway returned the contactId in the Create Processing Account method.

Note: If you don't have the contactId, use the List Contacts method to search for the contact.

Our gateway returns the following information about a contact:

  • Name and contact method, including their phone number or mobile number.
  • Role within the business, for example, if they are a manager.
get/contacts/{contactId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/contacts/{contactId}
  • Auth
    HTTP bearer

Path parameters

contactIdinteger required

Unique identifier for the contact.

Response

Successful request. Returns the requested contact.

contactIdinteger

Unique identifier of the contact.

type'manager' | 'representative' | 'others' required

Type of contact.

firstNamestring required

Contact's first name.

middleNamestring

Contact's middle name.

lastNamestring required

Contact's last name.

Changes