Membership Management - List Members
Used to obtain list of all active/expired profiles and related password info.
Intended to be used once a day to keep a 3rd party database in sync with our records.
Variable | Required | Max Size | Notes |
publisher-name | Mandatory | NA | Gateway account username issued to you. |
publisher-password | Mandatory | NA | Remote Client Password - This is different then the password used to login. |
mode | Mandatory | NA | Value needs to be set to ’list_members' |
status | Optional | NA | Type of profiles you want to retrieve.Allowed Values: ‘active’, ’expired’, and ‘all’.Defaults to ‘active’ when omitted. |
crypt | Optional | NA | Encryption method used to pre-encrypt passwords.Allowed Values: ‘crypt’ (.htaccess encryption), ‘md5’ (MD5 encryption), and ’none’ (not encrypted).Defaults to ‘crypt’ when omitted. |
expcc | Optional | 1 | Limit results to only profiles which have a CC exp date that will expire in X months from current date.Allowed Values: ‘1’ (1 month), ‘2’ (2 months), and ‘3’ (3 months).Defaults to blank/null when omitted. (See notes #1 & #2) |
Notes:
-
Omit this variable, if you do not intend to limit the results to only profiles with soon to expire credit cards.
-
When using this option, the response fields will be limited to username and exp date only. Set the ‘status’ field to ‘all’, if you require additional info about those soon to expire credit card using profiles.
Response Values - List Members
Variable | Value | Notes |
FinalStatus | success/problem | suceess - Profile data was located successfully.problem - Profile data failed to be located due to problem. |
auth-msg | Additional Message | |
MErrMsg | Error Message is applicable | |
axxxxx | (xxxxx will be a number - starting at 00000) | Returned data for each profile will be URL encoded and in the following format: (Order of fields not fixed)username=data&password=data&enddate=data&purchaseid=dataRecord will be URL encoded. |
TranCount | number of records | Number of profiles returned.(i.e. if TranCount is ‘5’ then you would look at ‘a00000’ through ‘a00004’) |