Membership Administration - Credit Member
Overview
The Credit Member operation uses payment information stored within an existing membership profile to process a return transaction. The customer’s payment information is retrieved from the profile, eliminating the need to resubmit account details. Only the return amount is required.
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 | credit_member |
Value must be set to credit_member. |
Return 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 returned. 1 |
transflags |
Optional | string | N/A | cit, mit |
Card on File indicators (for example cit, mit). See allowed values below and Card On File Requirements. |
origorderid |
Optional | string | N/A | — | Original Cardholder Initiated transaction orderID for subsequent Card on File charges. See Notes below. |
transflags Allowed Values
cit– Cardholder-initiated transaction using a credential currently stored on the membership profilemit– Merchant-initiated transaction using a credential currently stored on the membership profile
Card on File values (cit, mit) may be comma-joined with other applicable flags. Full CIT/MIT combinations are documented in Card On File Requirements.
Additional Supported Fields
In addition to the fields listed above, any supported transaction fields defined in Section 1. Remote Authorization may also be included in the request.
Response Parameters
The following response values are returned after the return transaction has been processed.
| Variable | Value | Description |
|---|---|---|
FinalStatus |
success, pending, badcard, problem |
success or pending indicates the return request was accepted successfully (processor dependent).badcard indicates the transaction failed due to a processor decline.problem indicates the transaction failed due to a processing or validation issue. |
Mstatus |
success, badcard |
Deprecated. Use FinalStatus instead. |
success |
yes, no, problem |
Transaction result indicator. |
avs-code |
string | Address Verification Service (AVS) response code. See AVS Response Codes. |
auth-code |
string | Authorization code returned by the processor. |
MErrMsg |
string | Error response message. |
errdetails |
string | If data validation or fraud checks fail, this field contains a pipe-delimited list of variables and associated error messages. Requires a FraudTrack2 subscription. |
aux-msg |
string | Additional response message. |
orderID |
string | Unique transaction identifier used for future transaction management operations, including voids and additional returns. |
user-agent |
string | Browser or identifier of the posting system. |
ipaddress |
string | IP address of the posting system. |
Duplicate |
yes | If the transaction’s orderID has been previously submitted, the value is set to yes and the remaining response fields will contain the values returned by the original transaction. |
Notes
Card on File (CIT / MIT)
credit_member issues a return using payment information already stored on the membership profile. Send the appropriate Card on File transflags value to identify whether the return is cardholder-initiated (cit) or merchant-initiated (mit).
When origorderid is required for subsequent CIT/MIT transactions, 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.
Stored Payment Information
This function uses the payment information associated with an existing membership profile. Payment account details do not need to be resubmitted as part of the request.
Processor-Dependent Responses
Some processors return a status of pending when a return request has been accepted but has not yet completed settlement processing. Applications should be designed to handle both success and pending response statuses.
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. ↩︎