Credit Cards - Pivotal Payments

QRG for OCX Method
Quick Reference Guide:
OCX Control Properties
Contents:
Credit Cards:
1.
2.
3.
4.
5.
6.
7.
Sale
Refund
Void
Pre-Auth
Offline Sale (Force Trans)
Tips
Batch Close
Debit Cards:
1.
2.
3.
4.
Sale
Refund
Tips
Batch Close
Command/Action Codes:
1. All Codes
Credit Cards:
Note: The following examples are the minimum properties needed for a manual, hand keyed, transaction being
passed from a POS system using the OCX control method. For swipe, track 1 or 2 data from the card needs to be
passed to .TRACK and .MANUAL passed with "1" to process correctly.
Note: Use .ClearVariables to ensure that all properties are clear before sending a transaction.
Sale:
QRG for OCX Method
.ACTION = 1
.CARD = 4012888888888886
.EXPDATE = 1208
.AMOUNT = 2.00
.SEND
Refund:
Without referencing original transaction:
.ACTION = 2
.CARD = 4012888888888886
.EXPDATE = 1208
.AMOUNT = 2.00
.SEND
With original reference number:
.ACTION = 2
.TRANSID = 12345 **
.SEND
Void:
.ACTION = 3
.TRANSID = 12345 **
.SEND
Pre-Auth:
.ACTION = 4
.CARD = 40128888888888886
.EXPDATE = 1208
.AMOUNT = 2.00
.SEND
Offline Sale:
Without referencing original pre-auth:
QRG for OCX Method
.ACTION = 5
.CARD = 4012888888888886
.EXPDATE = 1208
.AUTH = 12345678 ***
.AMOUNT = 2.00
.SEND
With original reference number:
.ACTION = 5
.TRANSID = 12345 **
.SEND
Tips:
Note: Traditionally tip amounts are hand-written on a sales receipt by the card holder and would only be entered
by the server once the customer has left the location. To support this, a gratuity command is performed and
added to the original transaction id.
.ACTION = 13
.TRANSID = 12345 **
.TIPAMOUNT = 5.00
.SEND
Batch Close:
.ACTION = 31
.PROCESSOR = 0 ****
.SEND
** .TRANSID value is original PNREF# of approved transaction. This number is nested within .REFERENCE
from the original transaction response properties. If the transaction was already batched out, a VOID attempt
will return a decline. In that case a REFUND needs to be processed.
*** .AUTH value is the original authorization # assigned by the issuing bank. This number can be obtained on a
pre-auth attempt as well as a voice authorization done over the phone with the processing bank. Depending on
the issuing bank an auth code value can be valid from 3 to 7 days.
**** .PROCESSOR is only necessary when batch closing CANADIAN credit or debit. Seperate batch close is
not necessary when processing credit & debit in the USA.
Debit Cards:
QRG for OCX Method
Note: Pin based debit transactions are managed by the pinpad controlled by the Pivotal Client. The only thing
necessary to be sent from the POS is the proper command code and amount of the transaction. The pinpad will
then take over for card swipe and the necessary prompts.
Sale:
.ACTION = 41
.AMOUNT = 2.00
.SEND
Refund:
.ACTION = 42
.AMOUNT = 5.00
.SEND
Tips:
Note: Pinbased debit tips are handled by a prompt on the pinpad. As long as the prompt is enabled in the Setup > Hardware -> Pinpad -> Advanced section of the client, the customer will be asked for a tip amount on any
SALE transaction.
Note: The Debit tip prompt is only supported in Canada. In the USA the full amount + tip needs to be entered
as a regular sale.
Batch Close:
Only necessary for Canadian debit with "merchant initiated close."
.ACTION = 31
.PROCESSOR = 1 ****
.SEND
Full List of Command Codes:
Credit Card:
Action Code
Description
1
Sale
2
Credit
QRG for OCX Method
3
Void Sale
4
Pre-Authorization
5
Post Authorization / Offline Sale
6
Void Credit
7
Void Post-Authorization
8
Commercial Card Sale
9
Commercial Card Credit
10
Commercial Card Post-Authorization
13
Gratuity
14
Sale with Gratuity
Debit:
Action Code Description
41
Sale
42
Return
43
Void
46
Void Return