Retrieve a list of membership profiles including status, credentials, and expiration information for synchronization or reporting purposes.

Membership Administration - List Members

Overview

The List Members operation retrieves a list of membership profiles from the system, including active, expired, or all members depending on the request parameters. This function is commonly used for periodic synchronization between Plug’n Pay and third-party databases.

Request Parameters

Account Credentials

Variable	Requirement	Type	Max Size	Possible Values / Example	Description
`publisher-name`	Mandatory	string	N/A	—	Gateway account username issued to you.
`publisher-password`	Mandatory	string	N/A	—	Remote Client Password. This is different than the password used to log in to the gateway.
`mode`	Mandatory	string	N/A	`list_members`	Value must be set to `list_members`.

Query Options

Variable	Requirement	Type	Max Size	Possible Values / Example	Description
`status`	Optional	string	N/A	`active`, `expired`, `all`	Type of profiles to retrieve. `active` = profiles with `enddate` ≥ today `expired` = profiles with `enddate` < today `all` = all profiles, regardless of `enddate` Defaults to `active` when omitted.
`crypt`	Optional	string	N/A	`bcrypt`, `omit`, `blank`	Controls how passwords are returned in profile records. `bcrypt` = passwords are hashed using bcrypt (default if omitted) `omit` = removes the `password` field completely from returned records `blank` = removes the `password` field completely from returned records
`alldata`	Optional	string	N/A	`yes`	Set to `yes` to return full customer profile data for each record (not only the default `username`, `password`, `enddate`, and `purchaseid` fields). Otherwise leave blank or omit the field completely.
`expcc`	Optional	integer	1	`1`, `2`, `3`	Filters results to profiles with credit cards expiring within a specified number of months. Allowed values: `1`, `2`, `3` months.

Response Parameters

The following values are returned after the list request is processed.

Variable	Value	Description
`FinalStatus`	`success`, `problem`	`success` indicates profile data was retrieved successfully. `problem` indicates the request failed.
`auth-msg`	string	Additional response message.
`MErrMsg`	string	Error message when applicable.
`axxxxx`	encoded profile data	Each record contains URL-encoded membership data. By default: `username=data&password=data&enddate=data&purchaseid=data` When `alldata` is `yes`, the record includes full customer profile data.
`TranCount`	number	Total number of profiles returned. Use this to determine how many `axxxxx` records to parse (starting from `a00000`).

Notes

API Response Performance

⚠️ Important: Unless passwords are actually being imported on the merchant side, it is highly recommended to use omit or blank for crypt. Omitting password hashing results in much faster response generation. In databases with large numbers of customer profiles, this is often the only way to generate the list in real time; otherwise the API connection may time out before all passwords can be hashed and any output is returned.

Expiring Card Filter

If expcc is used, results are limited to profiles with credit cards expiring within the selected time window.

When this filter is enabled:

Returned fields are limited to username and expiration date only.
To retrieve full profile data, set status to all.

Data Format Notes

Record Structure

Returned records follow a sequential naming pattern:

a00000
a00001
a00002
...

Decoding Requirements

Each record is URL encoded and must be decoded before parsing individual fields.