Membership Administration - Billing Member
Overview
The Billing Member operation processes a billing transaction using payment and customer information stored within an existing membership profile. Only the transaction amount is required, as all other payment details are retrieved from the stored profile.
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 | bill_member |
Value must be set to bill_member. |
Transaction Information
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description |
|---|---|---|---|---|---|
username |
Mandatory | string | 12 | — | Customer profile username. |
card-amount |
Mandatory | decimal | 10 | 1234.56 |
Amount to be charged. 1 |
transflags |
Optional | string | N/A | cit, mit, mit,recurring |
Card on File and recurring indicators (for example cit, mit, mit,recurring). See allowed values below and Card On File Requirements. |
origorderid |
Optional | string | N/A | — | Original Cardholder Initiated transaction orderID used for subsequent Card on File charges. See Notes below. |
sndemailflg |
Optional | integer | 1 | 1 |
Set to 1 to send a confirmation email for the transaction.See Notes below. |
transflags Allowed Values
cit– Cardholder-initiated transaction using a credential currently stored on the membership profilemit– Merchant-initiated transaction that is not a regularly scheduled recurring chargemit,recurring– Subsequent transaction in a series processed at fixed, regular intervalsrecurring– Marks the transaction as recurring billing (legacy; prefermit,recurringfor Card on File compliance)
Card on File values (cit, mit, and combinations such as mit,recurring) may be comma-joined. Full CIT/MIT combinations are documented in Card On File Requirements.
Additional Supported Fields
In addition to the fields listed above, any additional supported fields defined in Section 1. Remote Authorization may also be included in the request.
Response Parameters
The following response values are returned after the billing transaction has been processed.
| Variable | Value | Description |
|---|---|---|
FinalStatus |
success, badcard, problem, fraud |
success indicates approval.badcard indicates processor decline.problem indicates a non-card-related failure.fraud indicates rejection by FraudTrack2 rules. |
Mstatus |
success, badcard, problem |
Deprecated. Use FinalStatus. |
success |
yes, no, problem |
Transaction result indicator. |
avs-code |
string | Address Verification Service response code. See AVS Response Codes. |
auth-code |
string | Authorization code from processor. |
MErrMsg |
string | Error response message. |
errdetails |
string | Pipe-delimited validation or fraud error details (requires FraudTrack2). |
aux-msg |
string | Additional response message. |
orderID |
string | Unique transaction identifier used for future actions such as voids and returns. |
user-agent |
string | Identifier of the submitting system or browser. |
ipaddress |
string | IP address of the submitting system. |
Duplicate |
yes, no |
Indicates duplicate submission of orderID. If yes, original transaction data is returned. |
Notes
Card on File (CIT / MIT)
bill_member charges a payment method already stored on the membership profile. Send the appropriate Card on File transflags value to identify whether the charge is cardholder-initiated (cit) or merchant-initiated (mit / mit,recurring).
When origorderid is required for subsequent CIT/MIT charges, submit the orderID from the initial Cardholder Initiated transaction (cit,init or cit,init,recurring). See Card On File Requirements for when origorderid is required.
Confirmation Emails
By default, this billing mode does not send confirmation emails.
To enable email notifications for either the merchant or customer, set sndemailflg to 1.
Related Documentation
⚠️ Formatting Rule (Applies to All Amount Fields)
-
All monetary values must be numeric only in the format
1234.56. Do not include currency symbols, commas, or formatting. Exactly two decimal places are required. ↩︎