SchemaBoardingProcessing Accounts

List contacts

Use this method to retrieve a list of contacts for a processing account.

Note: If you want to view a specific contact and you have their contactId, go to our Retrieve Contact method.

To retrieve a list of contacts for a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the Create Merchant Platform method or the Create Processing Account method.

Our gateway returns the following information about each contact:

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

For each contact, we also return a contactId, which you can use to perform follow-on actions.

Path parameters

processingAccountIdstringRequired
Unique identifier that we assigned to the processing account.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
afterstringOptional
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limitintegerOptional<=100Defaults to 10
States the total amount of results the response is limited to.

Response

Successful request. Returns a list of contacts associated with the processing account.
countdouble or null
Number of results that we returned.
datalist of objects or null
Array of contact objects.
hasMoreboolean or null
Indicates that further results are available.
limitdouble or null
Maximum number of results that we return for each page.

Errors