<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR_SOURCE_KEY" PIN="1234" SANDBOX="yes" CARD="4111111111111111" EXPDATE="0919" AMOUNT="1.0" INVOICE="2134" DESCRIPTION="TEST" CVV="322" EMAIL="test@usaepay.com" EMAILCUSTOMER="false" CUSTNAME="John Doe" AVSSTREET="1234 Main" AVSZIP="21345" CLIENTIP="123.123.123.123" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR_SOURCE_KEY" PIN="1234" SANDBOX="yes" COMMAND="authonly" CARD="4111111111111111" EXPDATE="0919" AMOUNT="1.0" INVOICE="2134" DESCRIPTION="TEST" CVV="322" EMAIL="test@usaepay.com" EMAILCUSTOMER="false" CUSTNAME="John Doe" AVSSTREET="1234 Main" AVSZIP="21345" CLIENTIP="123.123.123.123" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR SOURCE KEY" PIN="1234" SANDBOX="yes" COMMAND="capture" REFNUM="47330639" AMOUNT="1.00" AUTHCODE="051429" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR SOURCE KEY" PIN="1234" SANDBOX="yes" CARDPRESENT="true" MAGSTRIPE="%B4275330012345675^3/TEST ^12041010000000439000000?;4275330012345675=120410100000043900?" AMOUNT="1.00" INVOICE="123456" DESCRIPTION="test" CUSTNAME="John Doe" CLIENTIP="123.123.123.123" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR SOURCE KEY" PIN="1234" ADDCUSTOMER="yes" SCHEDULE="weekly" NUMLEFT="10" BILLAMOUNT="10.00" SANDBOX="yes" CARDPRESENT="true" MAGSTRIPE="%B4275330012345675^3/TEST ^12041010000000439000000?;4275330012345675=120410100000043900?" AMOUNT="1.00" INVOICE="123456" DESCRIPTION="test" CUSTNAME="John Doe" CLIENTIP="123.123.123.123" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR SOURCE KEY" PIN="1234" COMMAND="void" INVOICE="123456" REFNUM="47330486" SANDBOX="yes" AMOUNT="1.00" DESCRIPTION="test" CUSTNAME="John Doe" CLIENTIP="123.123.123.123" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <body> <cfmodule template="usaepay.cfm" queryname="q_auth" KEY="YOUR SOURCE KEY" PIN="1234" COMMAND="refund" INVOICE="123456" REFNUM="47330480" SANDBOX="yes" AMOUNT="1.00" DESCRIPTION="test" CUSTNAME="John Doe" CLIENTIP="123.123.123.123" > <!--- Here you should include your own script for processing gateway responses. ----> <cfif #q_auth.UMstatus# is "Approved"> <h1>Transaction Approved</h1> <cfelse> <h1>Transaction Declined</h1> </cfif> <cfoutput query="q_auth"> <b>UMversion</b>: (#UMversion#) <br> <b>UMstatus</b>: (#UMstatus#) <br> <b>UMauthCode</b>: (#UMauthCode#) <br> <b>UMrefNum</b>: (#UMrefNum#) <br> <b>UMavsResult</b>: (#UMavsResult#) <br> <b>UMavsResultCode</b>: (#UMavsResultCode#) <br> <b>UMcvv2Result</b>: (#UMcvv2Result#) <br> <b>UMcvv2ResultCode</b>: (#UMcvv2ResultCode#) <br> <b>UMresult</b>: (#UMresult#) <br> <b>UMerror</b>: (#UMerror#) <br> <b>UMfiller</b>: (#UMfiller#) <br> </cfoutput> </body> </html>
Property | Description |
---|---|
queryname | (defaults to q_auth.) |
key | Source Key generated by the Merchant Console at www.usaepay.com. |
pin | Pin for Source Key. This field is required only if the merchant has set a Pin in the merchant console. |
amount | Charge amount without $. The amount field should include the total amount to be charged, including sales tax. |
invoice | Unique ticket, invoice or order number. 10 digits. |
Commercial CardSupport | |
ponum | Customer purchase order number. Only required for commercial cards. |
tax | The portion of amount that is sales tax. |
nontaxable | Set to yes if transaction is not taxable. (optional, platform dependent) |
Amount details (optional) | |
shipping | Shipping charges. |
discount | Discount amount (ie gift certificate or coupon). |
subtotal | Order subtotal. If set, then subtotal + tip + shipping - discount + tax must equal amount or the transaction will be declined. If subtotal is left blank, it will be ignored. |
tip | The portion of amount that is tip. |
allowpartialauth | Yes/No. Indicates whether to allow a partial authorization if the full UMamount is not available (for debit, prepaid and gift cards). If left blank or set to No, the transaction will be automatically canceled and reversed if full UMamount is not available |
currency | Currency of “amount.” Required if using a MCP based account. Must be one of the 3 digit numeric codes found here. |
Card Not Present Transactions | |
card | Credit Card Number with no spaces or dashes. |
expdate | Expiration Date in the form of MMYY with no spaces or punctuation. |
cardholder | Name as it appears on the creditcard. |
street | Street Address for use in AVS check |
zip | Zipcode for AVS check |
magstripe | Track 1, Track 2 or both Tracks read from credit card. |
cardpresent | Marks transaction as a card present transaction. true or false |
termtype | The type of terminal being used: Optons are POS (cash register), StandAlone (self service terminal), Unattended (ie gas pump), Unkown. (defaults to Unknown) |
magsupport | Support for mag stripe reader: yes, no, contactless or unknown (default is unknown unless magstripe has been sent) |
contactless | Magstripe was read via contactless swiper: yes or no (default is no) |
dukpt | DUK/PT key for Pin-Debit transactions. The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the Pin Pad serial number and transaction counter. |
signature | Raw cardholder signature captured by pos device. (does not need to be encoded) |
Electronic Check Transactions | |
routing | Bank routing number. Required for check transactions. |
account | Bank account number. Required for check transactions. |
ssn | Social Security Number |
dlnum | Driver's License Number. Required for check transactions if not using SSN. |
dlstate | Driver's License Issuing State. Required for check transactions if not using SSN. |
checknum | The checknumber. (optional) |
checkimagefront | JPG image of front side of check. (optional). Use raw image data, do not encode using base64 |
checkimageback | JPG image of back side of check. (optional) |
auxonus | Aux On US for check 21 |
epccode | EPC Code for check 21 |
accounttype | Checking or Savings. Default is Checking |
Secure Vault Payments (Direct Pay) | |
svpbank | ID of cardholder's bank |
svpreturnurl | URL that the bank should return the user to when tran is completed |
svpcancelurl | URL that the bank should return the user if they cancel |
Option parameters | |
origauthcode | Originating Auth Code, required when running the postauth command. Typically used when a voice authorization is obtained. |
command | Command to run; Possible values are: cc:sale, cc:authonly, cc:capture, cc:credit, cc:postauth, check:sale, check:credit, void, refund and creditvoid Default is cc:sale. |
orderid | Unique order identifier. Used to reference the order to which the transaction corresponds. This field can contain up to 64 characters and should be used instead of invoice when orderids longer that 10 digits are needed. |
custid | Alpha-numeric code that uniquely identifies the customer. |
description | Charge description (optional). |
cvv | CVC/CVV2 code (optional). |
custemail | Customer Email address (optional). |
custreceipt | Send a customer receipt. Note, this will override the source setting. (defaults to no) |
custreceiptname | Use a custom email receipt template |
ignoreduplicate | Suppresses the duplicate folding feature. |
clientip | IP Address of client browser, used for fraud checks. (optional) |
sandbox | If set to true will use the sandbox server. |
timeout | Sets how long to wait, in seconds, for a reply from the gateway before returning an error. (optional, defaults to 45 seconds) |
comments | Comments or long desription |
software | Allows developers to send the name and version of their application in to the gateway. |
Card Authorization - Verified By Visa and Mastercard SecureCod | |
cardauth | Enables Cardholder Authentication. The merchant must have a Cardinal Commerce account enabled in the gateway. If they don't have an account, this field will be ignored and the transaction will be processed normally (without authentication). Set cardauth=1 to enable cardholder authentication, set cardauth=0 to disable authentication. (defaults to disabled) |
pares | The authentication response received from an independent authentication site. |
xid | |
cavv | |
eci | |
Customer Database | |
addcustomer | If set to yes and the transaction has been approved, the system will create a new customer record and store the payment information for future use. (Yes/No) |
schedule | How often to run the transaction. Possible values are: daily, weekly, biweekly, monthly, bimonthly, quarterly, biannually, annually. Default is monthly. If you do not want to enable recurring billing for this customer, set schedule=“disabled” |
numleft | The number of times to left in billing cycle. Either a number or * for unlimited. (default is *) |
start | When to start the schedule. Must be in YYYYMMDD format. To begin one billing period from today, set to “next.” (For example, if today is 5/1/2007 and schedule is “monthly” the recurring billing will start on 6/1/2007.) If left blank, default is “tomorrow.” |
end | When to stop running transactions. Default is to run forever. If both end and numleft are specified, transaction will stop when the earliest condition is met. |
billamount | Optional recurring billing amount. If not specified, the amount field will be used for future recurring billing charges. |
billtax | Optional recurring billing tax. If not specified, the tax field will be used for future recurring billing charges. |
billsourcekey | If set to true, for future recurring billing charges will be run using the same source key as the original transaction. By default recurring charges run using a source key labeled “Recurring”. |
Billing Address Fields | |
billfname | |
billlname | |
billcompany | |
billstreet | |
billstreet2 | |
billcity | |
billstate | |
billzip | |
billcountry | |
billphone | |
fax | |
website | |
Shipping Address Fields (optional) | |
shipfname | |
shiplname | |
shipcompany | |
shipstreet | |
shipstreet2 | |
shipcity | |
shipstate | |
shipzip | |
shipcountry | |
shipphone | |
Custom Data Fields (optional) | |
custom1 | |
custom2 | |
custom3 | |
custom4 | |
custom5 | |
custom6 | |
custom7 | |
custom8 | |
custom9 | |
custom10 | |
custom11 | |
custom12 | |
custom13 | |
custom14 | |
custom15 | |
custom16 | |
custom17 | |
custom18 | |
custom19 | |
custom20 | |
Line items | |
lineitem*sku | Product id, code or SKU |
lineitem*name | Item name or short description |
lineitem*description | |
lineitem*cost | Cost of item, each |
lineitem*qty | Quantity of item, each |
lineitem*taxable | Y = Taxable, N = Non-taxable |
Split Payments | |
key* | Additional source key, ex. key2 - second source key for multiple payments in a single call |
amount* | amount of the additional transaction |
invoice* | invoice number - can be omitted |
command* | command - can be omitted |
orderid* | order ID - can be omitted |
description* | description - can be omitted |
onerror | Instructs the gateway what to do when a decline is received when multiple transactions are being processed (see “Split Payments” above). Can be set to Stop, Continue or Void. Defaults to “Stop” |
Field | Description |
---|---|
x_response_code | full result: Approved, Declined, Error |
x_auth_code | Authorization Code |
x_trans_id | Reference Number |
x_avs_code | The Result of the AVS check. |
x_cvv_code | The result of the CVV2 check. |
x_response_reason_text | Error if transaction is not approved. |
1.3 -> 2.0: the following features added: Sandbox support Line items Custom fields Card Present Transactions Capture and Refund Transaction Split Payments Secure Vault Payments (Direct Pay) Recurring Billing 03/15/10
1.2 -> 1.3: Fixed problem with the dependency of the result variables from the gateway. 04/04/04
1.0 -> 1.2 Added support for VBV and MSC as well as other fields (tax, po...). 10/15/03