Sign in
processingAccounts

List contacts

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

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

To list 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.

get/processing-accounts/{processingAccountId}/contacts

Path parameters

processingAccountIdstring required

Unique identifier that we assigned to the processing account.

Query parameters

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a list of contacts associated with the processing account.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean

Indicates whether there is another page of results available.

Changes

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