Enrollments

List Enrollments

This operation returns a (paged) list of all (active) Enrollments for the authenticated Agent, optionally filtered to a single Merchant with the merchantKey query parameter.

Requires enrollments:List permission.

get/enrollments

Request

Query parameters

sortOrder'asc' | 'desc'

The sort order, __asc__ending or __desc__ending

limitinteger

The number of items to return

offsetTokenstring

The offset token. This token is returned in the response of previous request.

archivedboolean

If set to true it will return only archived merchants.

merchantKeystring

Uniquely identifies a Merchant

Example:mct-123dinkqFqfq3q2f2adfa

Immutable, unique identifier of the merchant

Response

A (paged) list of Enrollments

offsetTokenstring
moreItemsboolean

Changes

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