Transaction Administration - Force Auth


Used to settle a transaction with a previously obtained auth-code -typically via a phone authorization.

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 ‘forceauth’
auth-code Mandatory Authorization code you were provided when you called for the authorization.
orderID Optional 20 Unique numeric order ID used to identify transaction for any future activity including voids and returns. If not submitted, one will be generated for you.
card-amount Mandatory 10 Format: 1234.56 - Total amount to be charged.
card-name Mandatory 39 Name as it appears on credit card.
card-address1 Optional 39 Billing Street Address Line 1 (see note 1)
card-address2 Optional 39 Billing Street Address Line 2 (see note 1)
card-city Optional 39 Billing City Address (see note 1)
card-state Optional 2 Billing State Address - 2 Char. State Code (see note 1)
card-zip Optional 10 Billing Zip Address (see note 1)
card-country Optional 3 Billing 2 Char. Country Code (see note 1)
card-number Mandatory 16 Credit Card # - Format: 4111111111111111
card-exp Mandatory 5 Credit Card Expiration Date. Format: MM/YY
notify-email Optional NA Email Address to send alert notice for transaction problems.

Notes:

  1. These variables are optional but highly recommended.

Response Values - Force Auth

Variable Value Notes
FinalStatus success/problem/pending Will return ‘success’ or ‘pending’ (processor dependent) upon success. Will return ‘probelm’ on failure
success yes/no Will return ‘success’ upon success or ’no’ upon failure.
Mstatus sucess/problem/pending Deprecated in favor of FinalStatus
Aux-msg Aux message if applicable on success. orderid has been successfully marked for settlement.
MErrMsg Error Message if applicable. orderid was not marked successfully. Transaction may not be marked.
Duplicate yes/blank yes - If the orderID of the transaction has previously submitted, then the value of ‘Duplicate’ will be set to ‘yes’ and the values of the other fields will be the same as the original transaction.