Retrieve billing transaction history for a membership profile within a specified date range.

Membership Administration - Query Member Billing History

Overview

The Query Member Billing History operation retrieves billing transaction history associated with a membership profile. Results may be filtered by username and date range to locate specific billing activity.

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 query_billing Value must be set to query_billing.

Search Criteria

Variable Requirement Type Max Size Possible Values / Example Description
username Mandatory string 12 — Customer profile username.
startdate Optional string 8 YYYYMMDD Beginning date for the search range.
Format: YYYYMMDD
enddate Optional string 8 YYYYMMDD Ending date for the search range.
Format: YYYYMMDD

Response Parameters

The following response values are returned after the billing history query has been processed.

Variable Value Description
FinalStatus success, problem success indicates billing history records were located successfully.
problem indicates the query could not be completed.
MErrMsg Error Response Message Error message when applicable.
DRXXXXX string Returned billing history data record.

Notes

Default Date Ranges

If username is not submitted, the date range is restricted to a maximum two-day period.

If username is submitted and startdate is not specified, the search defaults to 120 days prior to the date of the query.

Data Record Format

Billing history records are returned using a DRXXXXXX naming convention.

The numeric suffix is a sequential identifier beginning with:

DR000000
DR000001
DR000002
...

Each returned variable contains a single billing history record.

Response Decoding

Returned billing history records are URL encoded twice.

To properly parse the response:

  1. Split the initial response using the & delimiter.
  2. URL decode the resulting data record.
  3. URL decode the data record a second time.
  4. Parse the resulting data into individual fields.

Failure to perform both decoding operations may result in improperly formatted data.