Quick Start Guide

Sale Transaction (Credit Card) 2018-01-15T18:05:33+00:00

Sale Transaction (Credit Card)

Although there are many different calls you can make to our API our example below will focus on building a basic sale transaction request.  The concepts learned here will apply to most of our API requests.

Basic Transaction Components

While all of the above may seem like a lot of information the request is actually very simple. The table below explains how to build a basic sale request. Additional parameters and associated details can be found in our Full API Reference Manual.

The fields below are a subset of the all fields that can be used with a sale transaction. Please review our full reference site for additional information about sale transactions.

Building Your Request

Parameter Description Values Example Value
API Operation
requestType Specifies the type of operation to be performed. In this example we are focusing on sale transaction operations. Values Sale
https://secure.ziftpay.com/gates/xurl?&requestType=sale&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&amount=500&accountType=R&accountNumber=4111111111111111
&accountAccessory=0817&holderName=Lionel+Cosgrove&transactionIndustryType=RE&street=123+My+Street
&city=My+City&state=UT&zipCode=87653&transactionCode=000000001
Authentication
username Username for your API user account. NOTE: This is not the same as your merchant portal account. String api-user-1234
password Password for your API user account. String mypass1234
https://secure.ziftpay.com/gates/xurl?&requestType=sale&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&amount=500&accountType=R&accountNumber=4111111111111111
&accountAccessory=0817&holderName=Lionel+Cosgrove&transactionIndustryType=RE&street=123+My+Street
&city=My+City&state=UT&zipCode=87653&transactionCode=000000001
Merchant Context
merchantAccountCode Specifies which merchant account to use for this transaction. Your API user may be associated with more than one merchantAccountCode. String 21234
https://secure.ziftpay.com/gates/xurl?&requestType=sale&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&amount=500&accountType=R&accountNumber=4111111111111111
&accountAccessory=0817&holderName=Lionel+Cosgrove&transactionIndustryType=RE&street=123+My+Street
&city=My+City&state=UT&zipCode=87653&transactionCode=000000001
Payment Details
amount Specifies the total amount of the transaction in cents (not dollars). 5 dollars = 500 cents String 500
accountType Specifies the payment method to be used with this transaction Values R
accountNumber If accountType (above) is set to C this field contains the credit card number
If accountType is set to C or S this field contains the checking or savings account number.
String 41111111111111111
accountAccessory If accountType(above) is set to C this field contains the credit card expiration date. Month and year are represented by 4 digits. Example August 2017 = 0817.
If accountType is set to C or S this field contains the routing number.
String 0817
holderName Specifies the name of the card or account holder. String Lionel Cosgrove
transactionIndustryType Specifies the industry related to this transaction. Values RE
https://secure.ziftpay.com/gates/xurl?&requestType=sale&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&amount=500&accountType=R&accountNumber=4111111111111111
&accountAccessory=0817&holderName=Lionel+Cosgrove&transactionIndustryType=RE&street=123+My+Street
&city=My+City&state=UT&zipCode=87653&transactionCode=000000001
Customer Information
street Street address of customer. String 123 My Street
city City of customer String My City
state State of customer String UT
zip Zip Code of customer String 87653
https://secure.ziftpay.com/gates/xurl?&requestType=sale&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&amount=500&accountType=R&accountNumber=4111111111111111
&accountAccessory=0817&holderName=Lionel+Cosgrove&transactionIndustryType=RE&street=123+My+Street
&city=My+City&state=UT&zipCode=87653&transactionCode=000000001
External Identifiers
transactionCode External system identifier. Stored on transaction record. Returned in transaction response. String 00001
https://secure.ziftpay.com/gates/xurl?&requestType=sale&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&amount=500&accountType=R&accountNumber=4111111111111111
&accountAccessory=0817&holderName=Lionel+Cosgrove&transactionIndustryType=RE&street=123+My+Street
&city=My+City&state=UT&zipCode=87653&transactionCode=000000001

Transaction Response

When you have submitted a transaction to the Zift Gateway you will get a response back indicating the status of the transaction.   Below is a list parameters sent back as part of the API response.

responseType=sale
approvalCode=018930
providerAvsResponseCode=Y
accountNumberMasked=4***********1111
avsResponseCode=4E
responseCode=A01
avsResultCode=4E
entryModeType=MX
cscResponseCode=
balance=
referenceNumber=9198951
cycleCode=2366331
entryMediumType=MC
holderVerificationModeType=
holderName=Lionel Cosgrove
amount=50
extendedAccountType=VD
warningCode=00
accountType=R
transactionCode=000000001
transactionDate=20160818
token=VD20000000000000053648
merchantAccountCode=21234
feeAmount=
providerReferenceNumber=26
originalAmount=50
accountAccessory=0817
providerCscResponseCode=
responseMessage=Approved+%28Success%29
currencyCode=USD
processorCode=018930
terminalMessage=
processorResponse=