One Solution. Higher Profits
PayLeap Transaction API Guide
V isit us at: http://www.payleap.com
Copyright © 2010 PayLeap, LLC. All Rights Reserved.
Congratulations on the selection of the PayLeap Payment Gateway, the most
advanced solution in the industry for processing credit cards, debit cards, EBT
cards, gift cards, and electronic check services. The PayLeap Payment Gateway
provides you with a fast, easy, reliable way to process IP based transactions.
This guide prepares you with the detailed information that you will need to
develop, configure, and test your payment processing solution.
Your opinion is important to us. If you have any suggestions feel free to email us.
T hank you for choosing Pay L eap, L L C!
PayLeap, LLC
455W 255N
Warsaw, Indiana 46582
Email: [email protected]
Phone: 866-267-9609
Support
PayLeap is committed to providing the highest quality tools and customer
support. If you have any questions, comments or suggestions please contact
PayLeap by:
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
1
One Solution. Higher Profits
PayLeap Transaction API Guide
Email: [email protected]
Phone: 866-267-9609
L I M I T E D W A R R A N T Y . THE SITE AND SERVICES ARE PROVIDED ON AN "AS IS," "AS
AVAILABLE" BASIS. NEITHER COMPANY, NOR ITS PARENT CORPORATION, REPRESENTS OR
WARRANTS THAT THE SITE OR SERVICES WILL BE AVAILABLE, ACCESSIBLE,
UNINTERRUPTED, TIMELY, SECURE, ACCURATE, COMPLETE, ENTIRELY ERROR-FREE OR
VIRUS FREE NOR DOES COMPANY MAKE ANY WARRANTY AS TO THE RESULTS THAT MAY BE
OBTAINED FROM THE USE OF THE SITE OR SERVICES OR AS TO THE ACCURACY OR
RELIABILITY OF ANY CONTENT OR ANY INFORMATION OR PRODUCTS OBTAINED THROUGH
THE SITE OR THAT DEFECTS IN THE SERVICES WILL BE CORRECTED. YOU EXPRESSLY
ACKNOWLEDGE THAT THIS SITE AND THE SERVICES ARE COMPUTER NETWORK-BASED
SERVICES, WHICH MAY BE SUBJECT TO OUTAGES, INTERRUPTIONS, ATTACKS BY THIRD
PARTIES AND DELAY OCCURRENCES. IN SUCH AN EVENT AND SUBJECT TO THE TERMS
HEREOF, COMPANY SHALL USE COMMERCIALLY REASONABLE EFFORTS TO REMEDY
MATERIAL INTERRUPTIONS AND WILL PROVIDE ADJUSTMENTS, REPAIRS AND
REPLACEMENTS, WITHIN ITS CAPACITY, THAT ARE NECESSARY TO ENABLE THE SITE AND
THE SERVICES TO PERFORM THEIR INTENDED FUNCTIONS IN A REASONABLE MANNER. YOU
ACKNOWLEDGE THAT COMPANY DOES NOT WARRANT THAT SUCH EFFORTS WILL BE
SUCCESSFUL. IF COMPANY'S EFFORTS ARE NOT SUCCESSFUL, YOU MAY TERMINATE THE
APPLICABLE SERVICE AGREEMENT AND CEASE USING THE SITE. THE FOREGOING SHALL
CONSTITUTE YOUR SOLE REMEDY, AND COMPANY'S SOLE LIABILITY, IN THE EVENT OF
INTERRUPTION, OUTAGE OR OTHER DELAY OCCURRENCES IN THE COMPANY SERVICES. YOU
WAIVE AND COVENANT NOT TO ASSERT ANY CLAIMS OR ALLEGATIONS OF ANY NATURE
ARISING FROM OR RELATING TO YOUR USE OF THE SITE OR SERVICES, INCLUDING, WITHOUT
LIMITATION, ALL CLAIMS AND ALLEGATIONS RELATING TO THE ALLEGED INFRINGEMENT
OF PROPRIETARY RIGHTS, THE ALLEGED INACCURACY OF CONTENT, OR ALLEGATIONS THAT
COMPANY HAS OR SHOULD INDEMNIFY, DEFEND, OR HOLD YOU HARMLESS FROM ANY
CLAIM OR ALLEGATION ARISING FROM YOUR USE, REPUBLICATION OR OTHER
EXPLOITATION OF THE SITE OR SERVICES. YOU USE THE SITE AT YOUR OWN RISK AND
NEITHER COMPANY NOR THE PARTIES WHO PROVIDE INFORMATION AND MATERIALS FOR
PUBLICATION WITHIN THE SITE WILL BE LIABLE FOR ANY DAMAGES ARISING FROM YOUR
USE OF THIS SITE. YOU UNDERSTAND AND AGREE THAT ANY SITE. FOR THE AVOIDANCE OF
DOUBT, YOU AGREE THAT COMPANY DOES NOT REPRESENT OR WARRANT THAT THE
SERVICES OR SITE WILL BE AVAILABLE, ACCESSIBLE, UNINTERRUPTED, TIMELY, SECURE,
ACCURATE, COMPLETE, OR ENTIRELY ERROR-FREE.
L I M I T A T I O N O F L I A B I L I T Y . P A Y L E A P EXPRESSLY DISCLAIMS ANY LIABILITY OR LOSS
ARISING FROM OR RELATED TO THE SITE OR THE SERVICES (HOWEVER ARISING, INCLUDING
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
2
One Solution. Higher Profits
PayLeap Transaction API Guide
NEGLIGENCE), INCLUDING WITHOUT LIMITATION, LIABILITY OR LOSS ASSOCIATED WITH
UNAUTHORIZED ACCESS TO ANY SERVER, MERCHANT INTERFACES, WEBSITES, FACILITIES,
OR YOUR DATA OR YOUR CUSTOMER DATA (INCLUDING CREDIT CARD NUMBERS AND
OTHER PERSONALLY IDENTIFIABLE INFORMATION) DUE TO ACCIDENT, ILLEGAL OR
FRAUDULENT MEANS, INCLUDING HACKING, OR DEVICES USED BY ANY THIRD PARTY, OR
OTHER CAUSES BEYOND PAYLEAP'S REASONABLE CONTROL.YOU EXPRESSLY AGREE THAT
PAYLEAP SHALL NOT BE LIABLE FOR ANY LOSS ARISING FROM INFILTRATION OF THE
SERVICES, THE PAYLEAP SYSTEM OR WEBSITE BY MEANS OF SOFTWARE VIRUSES, TROJAN
HORSES, WORMS, TIME BOMBS, OR ANY OTHER SOFTWARE PROGRAMS, OR TECHNOLOGY
DESIGNED OR INTENDED TO DISRUPT, DAMAGE, INTERCEPT OR EXPROPRIATE THE PAYLEAP
SERVICES OR ANY SYSTEM, PROGRAM, DATA OR PERSONAL INFORMATION OR LIMIT THE
FUNCTIONING OF THE SITE, SERVICES OR ANY SOFTWARE, HARDWARE, OR EQUIPMENT OR
TO DAMAGE OR OBTAIN UNAUTHORIZED ACCESS TO ANY DATA OR ANY INFORMATION OF
ANY THIRD PARTY.
E X C L USI O N. AS A CONDITION OF USE OF THE SITE AND SERVICES, YOU AGREE THAT
NEITHER COMPANY, NOR ANY OFFICER, AFFILIATE, DIRECTOR, SHAREHOLDER, AGENT,
CONTRACTOR OR EMPLOYEE OF COMPANY WILL BE LIABLE TO YOU OR ANY THIRD PARTY
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, PUNITIVE, OR CONSEQUENTIAL LOSS OF
PROFITS, LOSS OF EARNINGS, LOSS OF BUSINESS OPPORTUNITIES, DAMAGES, EXPENSES, OR
COSTS RESULTING DIRECTLY OR INDIRECTLY FROM, OR OTHERWISE ARISING IN
CONNECTION WITH THE SITE, SERVICES OR SERVICE AGREEMENTS, HOWEVER ARISING,
INCLUDING WITHOUT LIMITATION, THE INABILITY TO USE THE SERVICES OR FOR COST OF
PROCUREMENT OF SUBSTITUTE GOODS AND SERVICES OR RESULTING FROM ANY PRODUCTS,
SERVICES PROVIDED OR OBTAINED OR TRANSACTIONS ENTERED INTO THROUGH THE SITE
OR RESULTING FROM UNAUTHORIZED ACCESS TO, DELETION OR ALTERATION OF YOUR
TRANSMISSIONS OR DATA OR FAILURE OF THE SITE TO STORE YOUR TRANSMISSIONS OR
DATA, INCLUDING BUT NOT LIMITED TO, DAMAGES FOR LOSS OF PROFITS, USE, DATA OR
OTHER INTANGIBLE PROPERTY, EVEN IF COMPANY HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES. THE LIMITATIONS SET FORTH IN THIS SECTION APPLY TO THE ACTS,
OMISSIONS, NEGLIGENCE, AND GROSS NEGLIGENCE OF COMPANY AND ITS AFFILIATES,
PARENTS, SUBSIDIARIES, CONTRACTORS, SUBCONTRACTORS, OFFICERS, DIRECTORS,
SHAREHOLDERS, MANAGERS, EMPLOYEES, AND AGENTS, WHICH, BUT FOR THIS PROVISION,
WOULD GIVE RISE TO A COURSE OF ACTION IN CONTRACT, OR ANY OTHER LEGAL DOCTRINE.
MATERIAL OR DATA DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE USE OF THE
SITE OR THE SERVICES IS DONE AT YOUR OWN DISCRETION AND RISK AND THAT USER WILL
BE SOLELY RESPONSIBLE FOR ANY DAMAGE TO ITS COMPUTER SYSTEM, LOSS OF SERVICE
OR LOSS OF DATA THAT RESULTS FROM THE DOWNLOAD OR USE OF SUCH MATERIAL OR
DATA. D ISC L A I M E R. EXCEPT AS EXPRESSLY SET FORTH, COMPANY SPECIFICALLY
DISCLAIMS ALL REPRESENTATIONS, WARRANTIES, AND CONDITIONS WHETHER EXPRESS OR
IMPLIED, ARISING BY STATUTE, OPERATION OF LAW, USAGE OF TRADE, COURSE OF
DEALING, OR OTHERWISE, INCLUDING BUT NOT LIMITED TO, WARRANTIES OR CONDITIONS
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR
TITLE WITH RESPECT TO THE SITE OR SERVICES, OR OTHER SERVICES OR GOODS PROVIDED
THROUGH THIS
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
3
One Solution. Higher Profits
PayLeap Transaction API Guide
O verview
Testing
You can request a test account on our server to be established at our demo host
server. To request this account, please send your email request to our technical
support staff. Please include the following information with your test account
request: company name, your name, phone number, email address associated
with the test account, and which payment processor you would like to test. An
email response will be sent with valid test information.
Live Production Server
https://secure1.payleap.com/TransactServices.svc
WSDL
https://secure1.payleap.com/TransactServices.svc?WSDL
Test Server
https://uat.payleap.com/TransactServices.svc
WSDL
https://uat.payleap.com/TransactServices.svc?WSDL
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
4
One Solution. Higher Profits
PayLeap Transaction API Guide
Testing can be performed with the following test cards:
Card Type Number MasterCard 5000300020003003 Visa 4005550000000019 Discover 60011111111111117 Diners 36999999999999 AMEX 374255312721002 W eb Services
x
ProcessC heck ± Processes check transactions for a merchant
x
ProcessC redit C ard ± Processes credit card transactions for a merchant
x
ProcessDebit C ard ± Processes debit card transactions for a merchant
x
ProcessE B T C ard ± Processes EBT card transactions for a merchant
x
ProcessG ift C ard ± Processes gift card transactions for a merchant
x
V alid C ard ± Validates the credit card by checking the card length based
on the card type, performing a mod 10 checksum, and validating the
expiration date
x
V alid C ard L ength ± Validates the credit card length
x
V aild E xpDate ± Validates the expiration date of the credit card
x
V alid Mod10 ± Validates the credit card by performing a mod 10
checksum on the card number; returns (T/F)
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
5
One Solution. Higher Profits
PayLeap Transaction API Guide
ProcessCheck
This Web service operation processes check transactions for a merchant. The
URL to access this Web service is:
https://uat.payleap.com/TransactServices.svc/ProcessCheck
Descriptions of the parameters are listed below.
Parameter Value UserName Required. User name assigned in the payment server Password Required. Password for the user name assigned in the payment server Required. Type of the check transaction. Valid values are: x Sale to make a purchase with a check x Auth (Verify) to authorize/verify an amount of a check x Return to return the money of a settled check transaction to the check holder TransType x Void to undo an unsettled check transaction x Force to force a previous Sale transaction into the current batch (ForceSale) x Capture to settle a single transaction in the current batch;; only for terminal-­based processors x CaptureAll to settle all transactions in the current batch;; only for terminal-­based processors CheckNum Required except for these TransType¶VVoid, Capture, CaptureAll. Check number uniquely identifies each individual © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
6
One Solution. Higher Profits
PayLeap Transaction API Guide
check TransitNum Required except for these TransType¶VVoid, Capture, CaptureAll. Transit number uniquely identifies a bank routing number AccountNum Required except for these TransType¶VVoid, Capture, CaptureAll. Account number uniquely identifies a check KROGHU¶VEDQNDFFRXQWQXPEHU Amount MICR Required except for these TransType¶VVoid, Capture, CaptureAll. The total transaction amount in DDDD.CC format Optional. The Magnetic Ink Check Reader data line, which includes TransitNum, and AccountNum. Required for processing Check-­Present transactions Required except for these TransType¶VVoid, Capture, CaptureAll7KHFKHFNKROGHU¶VQDPHDVLWappears on the NameOnCheck check. The parameter may be required, depending on the PHUFKDQW¶VSURFHVVRUVHWXS This parameter will remove invalid characters. See list of Removed Characters for more details DL Optional. 7KHFKHFNKROGHU¶VGULYHU¶VOLFHQVHQXPEHU This parameter will remove invalid characters. See list of Removed Characters for more details SS 2SWLRQDO7KHFKHFNKROGHU¶V6RFLDO6HFXULW\1XPEHU This parameter will remove invalid characters. See list of Removed Characters for more details DOB 2SWLRQDO7KHFKHFNKROGHU¶VGDWHRIELUWK This parameter will remove invalid characters. See list of Removed Characters for more details StateCode 2SWLRQDO7KHFKHFNKROGHU¶VFKDUDFWHUVWDWHFRGH7KH
SDUDPHWHUPD\EHUHTXLUHGGHSHQGLQJRQWKHPHUFKDQW¶V
processor setup. This parameter will remove invalid characters. See list of Removed Characters for more details © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
7
One Solution. Higher Profits
PayLeap Transaction API Guide
Optional. The type of the check. Valid values are: x Personal CheckType x Corporate x Government Extended data in XML format These tags may be required for Sale and Return transactions GHSHQGLQJRQWKHPHUFKDQW¶VSURFHVVRUVHWXSCityOfAccount, BillToStreet, and BillToPostalCode. Required tag for Return, Void, Force, and Capture transactions is: PNRef. RawMICR tag is required for processing Check-­Present transactions. Valid values are: ExtData x <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 30) x <PNRef>PNRef</PNRef> for a reference number assigned by the payment server x <Phone>Phone</Phone> for phone number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <Email>EMail</EMail> for email address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <RawMICR>RawMICR</RawMICR> for raw Magnetic Ink Check Reader data from the check reader in the format of: © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
8
One Solution. Higher Profits
PayLeap Transaction API Guide
TransitNumTAccountNumOCheckNum x <InvNum>InvNum</InvNum> for invoice tracking number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode;; either T or F x <AllianceNum>AllianceNum</AllianceNum> is the Alliance number for the check x <AccountType>AccountType</AccountType> is the type bank account for the check. Valid values are Checking or Saving x <CityOfAccount>CityOfAccount</CityOfAccount> for city name of the check holder's residential address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <BillToStreet>BillToStreet</BillToStreet> for street name of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details. x <BillToCity>BillToCity</BillToCity> for city name of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <BillToState>BillToState</BillToState> for the two character state code of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <BillToPostalCode>BillToPostalCode</BillToPostalCode> for zip code of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <BillToCountry>BillToCountry</BillToCountry> for © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
9
One Solution. Higher Profits
PayLeap Transaction API Guide
country name of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <CustomerID>CustomerID</CustomerID> for customer ID. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details The following tables contain sample data you can use to test this Web service.
The User Name and Password parameters should be changed when testing the
examples yourself.
E xamples
E xample 1:
The example data below will process a manually entered check
Sale transaction through the payment server.
Parameter Value UserName test Password 123 TransType Sale CheckNum 1001 TransitNum 123456780 AccountNum 1234567890 Amount NameOnCheck StateCode 100.00 John Doe WA © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
10
One Solution. Higher Profits
PayLeap Transaction API Guide
ExtData <CityOfAccount>City</CityOfAccount><BillToStreet>123</Bil
lToStreet><BillToPostalCode>99999</BillToPostalCode> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V
A L</Message><AuthCode>G U E IJ Q</AuthCode><PNRef>2400</PNRef></R
esponse>
E xample 2:
The example data below will process a swiped check Sale
transaction through the payment server.
Parameter Value UserName test Password 123 TransType Sale CheckNum 1001 TransitNum 123456780 AccountNum 1234567890 Amount 100.00 © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
11
One Solution. Higher Profits
PayLeap Transaction API Guide
MICR NameOnCheck StateCode ExtData 1234567801234567890 John Doe WA <RawMICR>123456780T1234567890O1001</RawMICR> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><Message>A PPR O V A L</Message><AuthCode>A U T H N U M
121-704</AuthCode><PNRef>11622</PNRef> </Response>
E xample 3:
The example data below will process a manually-entered check
Return transaction through the payment server. The PN Ref element in the
E xtData parameter should be changed when testing this example yourself.
Parameter Value UserName test Password 123 TransType Return CheckNum 100 TransitNum 123456780 © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
12
One Solution. Higher Profits
PayLeap Transaction API Guide
AccountNum Amount NameOnCheck StateCode ExtData 1234567890 100.00 John Doe WA <PNRef>821</PNRef><CityOfAccount>Any Town</CityOfAccount><BillToStreet>123</BillToStreet><Bill
ToPostalCode>99999</BillToPostalCode><InvNum>1001</In
vNum> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments>
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V
A L</Message><AuthCode>G W N I C P</AuthCode><PNRef>2406</PNRef><E
xtData>InvNum=1001</ExtData>
</Response>
E xample 4:
The example data below will process a check Void transaction
through the payment server. The PN Ref element in the E xtData parameter
should be changed when testing this example yourself.
Parameter UserName Value test © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
13
One Solution. Higher Profits
PayLeap Transaction API Guide
Password 123 TransType Void ExtData <PNRef>2405</PNRef> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments>
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V
A L</Message><AuthCode>G W5NP Q</AuthCode><PNRef>2405</PNRef></
Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
14
One Solution. Higher Profits
PayLeap Transaction API Guide
ProcessCreditCard
This Web service operation processes credit card transactions for a merchant.
The URL to access this Web service is:
https://uat.payleap.com/TransactServices.svc/ProcessCreditCard
Descriptions of the parameters are listed below.
Parameter Value UserName Required. User name assigned in the payment server Password Required. Password for the user name assigned in the payment server Required. Type of the credit card transaction. Valid values are: x Sale to make a purchase on a credit card x Adjustment is used to modify an existing tip amount for an original sale.This applies to the processors that support restaurant adjustment transactions x Auth to authorize an amount on a credit card TransType x Return WRFUHGLWWKHFDUGKROGHU¶VDFFRXQW x Void to undo an unsettled transaction. Note: pass the Card Number and ExpDate with null values on voids x Force to place an Auth transaction into the current batch (PostAuth) or to place a transaction not processed through the payment server into the current batch (ForceAuth) x Capture to settle a single transaction in the current batch;; only for terminal-­based processors x CaptureAll to settle all transactions in the current batch;; only © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
15
One Solution. Higher Profits
PayLeap Transaction API Guide
for terminal-­based processors or host-­based processors that support a batch release feature x RepeatSale to perform a recurring billing or installment payment transaction CardNum Optional except for these TransType¶VSale, Auth, Return, Force (ForceAuth). Credit card number to process the transaction. For all other transaction types the parameter needs to be included ExpDate Optional except for these TransType¶VSale, Auth, Return, Force (ForceAuth). &UHGLWFDUG¶VH[SLUDWLRQGDWHLQ00<<IRUPDW
For all other transaction types the parameter needs to be included MagData Optional except when processing swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-­Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678 Optional, depending on different merchant processor setups. The FDUGKROGHU¶VQDPHDVLWDSSHDUVRQWKHFDUGThis parameter will NameOnCard remove invalid characters. See list of Removed Characters for more details Amount Optional except for these TransType¶VAuth, Sale, Return, Force (both PostAuth and ForceAuth). The total transaction amount in DDDD.CC format InvNum Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details PNRef Optional except for these TransType¶VVoid, Force (PostAuth), Capture. Reference number assigned by the payment server © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
16
One Solution. Higher Profits
PayLeap Transaction API Guide
Zip Optional depending on different merchant processor setups. &DUGKROGHU¶VELOOLQJDGGUHVV]LSFRGHXVHGLQDGGUHVVYHULILFDWLRQ
This parameter will remove invalid characters. See list of Removed Characters for more details Street Optional depending on different merchant processor setup. &DUGKROGHU¶VELOOLQJVWUHHWDGGUHVVXVHGLQDGGUHVVYHULILFDWLRQThis parameter will remove invalid characters. See list of Removed Characters for more details CVNum Optional. Card verification number Optional except in the cases of: AuthCode (required for a Force (ForceAuth) transaction);; City and BillToState (required by certain processors);; Invoice and associated nested data elements (required for Concord EFS Purchase Card Level 3 and Fuel purchases-­ see section below). Extended data in XML format. Valid values are: x <AuthCode>ApprovalCode</AuthCode> for original authorization code x <CustCode>CustomerCode</CustCode> for customer code or ExtData PO number of the customer. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details (Note* This is the tag to be passed for Level II information for Global Payments only, please use PONUM for the other processors that support level II.) x <TipAmt>TipAmount</TipAmt> for tip amount in DDDD.CC format x <TaxAmt>TaxAmount</TaxAmt> for tax amount in DDDD.CC format x <SequenceNum>SequenceNum</SequenceNum> for sequence number used with RepeatSale installment transactions;; this designates which number in the sequence the transaction is;; it must be a positive integer smaller than or equal to the SequenceCount © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
17
One Solution. Higher Profits
PayLeap Transaction API Guide
x <SequenceCount>SequenceCount</SequenceCount> for sequence count used with RepeatSale installment transactions;; this designates the total number of charges that will be made;; it must be a positive integer greater than or equal to the SequenceNum x <ServerID>ServerID<ServerID> for a unique server identification number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 40) x <TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode;; either T or F x <Force>Force</Force> for forcing duplicate transactions to be processed;; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction x <RegisterNum>RegisterNum</RegisterNum> for register number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <City>City</City> for the city name of the cardholder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <BillToState>State</BillToState> for the two character state code of the cardholder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details x <CustomerID>CustomerID</CustomerID> for customer ID x <PONum>PONum</PONum> for purchase order number. The data within this XML tag parameter will remove invalid © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
18
One Solution. Higher Profits
PayLeap Transaction API Guide
characters. See list of Removed Characters for more details (Note* This is to be used for Level II information except Global Payments) x <BillPayment>BillPayment</BillPayment> to indicate that a transaction is a utility bill payment;; either T or F;; only supported for TransType¶VSale and RepeatSale;; This tag is only relevant to Retail, MOTO, and eCommerce markets. x
<CVPresence>CVPresence Value</CVPresence> CVV2 / CVC2 / CID Presence, indicates whether a CVV2 or CID has been sent along with the request.The valid values for this tag are: None, NotSubmitted, Submitted Illegible, NotPresent (Not present on card). *Please see sample request and response for this CVPresence tag field. x
<EntryMode>EntryModeValue</EntryMode> this was added to indicate how the values for the payment information were obtained. The Valid values for this tag are: UNKNOWN, MANUAL,MAGNETICSTRIPE,ICC, and PROXIMITY x <Invoice>Invoice</Invoice> to indicate invoice details will be included. See below for hierarchy of required and optional elements nested within. Please note that all elements included inside <Invoice> must be in the specific order listed below ™
<Invoice> ¾
<InvNum>InvNum</InvNum> Purchase invoice number ¾
<Date>Date</Date> Date of invoice in YYMMDD format for Concord ¾
<BillTo> ƒ
<CustomerId>CustomerId</CustomerId> Customer ID number ƒ
<Name>Name</Name> Customer name ƒ
<Address> Customer address x
<Street>Street</Street> Customer address © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
19
One Solution. Higher Profits
PayLeap Transaction API Guide
street x
<City>City</City> Customer address city x
<State>State</State> Customer address state x
<Zip>Zip</Zip> Customer address zip code x
<Country>Country</Country> Customer address country ƒ
</Address> ƒ
<Email>Email</Email> Customer email ƒ
<Phone>Phone</Phone> Customer phone number ƒ
<Fax>Fax</Fax> Customer fax number ƒ
<CustCode>CustCode</CustCode> Customer code ƒ
<PONum>PONum</PONum> Purchase order number from customer ƒ
<TaxExempt>TaxExempt</TaxExempt> Customer tax exempt status ¾
</BillTo> ¾
<Description>Description</Description> Description of purchase x
<SKU>SKU</SKU> SKU number of item x
<DiscountAmt>DiscountAmount</DiscountAmt
> Possible discount amount on item x
<TaxAmt>TaxAmt</TaxAmt> Possible tax amount on item x
<TotalAmt>TotalAmt</TotalAmt> Total amount of item x
<TaxRate>TaxRate</TaxRate> Possible tax rate © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
20
One Solution. Higher Profits
PayLeap Transaction API Guide
applied to item ƒ
™
</Item> ¾
</Items> ¾
<DiscountAmt>DiscountAmount</DiscountAmt> Possible total discount for invoice ¾
<ShippingAmt>ShippingAmt</ShippingAmt> Possible shipping amount for invoice ¾
<DutyAmt>DutyAmt</DutyAmt> Possible duty amount for invoice ¾
<TaxAmt>TaxAmt</TaxAmt> Possible tax amount for invoice ¾
<NationalTaxInc>NationalTaxInc</NationalTaxInc> Possible additional tax amount included in invoice total ¾
<TotalAmt>TotalAmt</TotalAmt> Total amount of the transaction on the invoice </Invoice> E xamples
The following tables contain sample data you can use to test this Web service.
The User Name and Password parameters should be changed when testing the
examples yourself.
E xample 1:
The example data below will process a manually-entered credit
card Sale transaction through the payment server. It will be processed even if it
is a duplicate transaction.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
21
One Solution. Higher Profits
PayLeap Transaction API Guide
Parameter Value UserName test Password 123 TransType Sale CardNum 5454545454545454 ExpDate 0509 NameOnCard John Doe Amount 1.00 ExtData <Force>T</Force> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V
A L</Message><AuthCode>006063</AuthCode><PNRef>2296</PNRef><Host
Code>03530E V V3 K 2Z A2F453Q</HostCode><GetAVSResult>N</GetAVSRe
sult><GetAVSResultTXT>No
M atch</GetAVSResultTXT><GetStreetMatchTXT>No
M atch</GetStreetMatchTXT><GetZipMatchTXT>No
M atch</GetZipMatchTXT><GetCommercialCard>F alse</GetCommercialCard
><ExtData>C ard T ype= M AST E R C A R D</ExtData></Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
22
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 2:
The example data below will process a manually-entered credit
card A uth transaction as a commercial card through the payment server.
Parameter Value UserName test Password 123 TransType Auth CardNum 4055016727870315 ExpDate 0509 NameOnCard John Doe Amount 1.00 InvNum 1001 ExtData <TaxAmt>0.50</TaxAmt><CustCode>102</CustCode> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V A L
V I T A L1</Message><AuthCode>V I T A L1</AuthCode><PNRef>2275</PNRef
><GetCommercialCard>T rue</GetCommercialCard><ExtData>InvNum=1001,
C ard T ype= V ISA</ExtData></Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
23
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 3:
The example data below will process a swiped credit card
Return transaction through the payment server.
Parameter Value UserName test Password 123 TransType Return CardNum 371449635398431 ExpDate 1205 MagData 371449635398431=05121015432112345678 NameOnCard Amount John Doe 1.00 Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V A L
V I T A L7</Message><AuthCode>V I T A L7</AuthCode><PNRef>2307</PNRef
><GetCommercialCard>F alse</GetCommercialCard><ExtData>C ard T ype= A
M E X</ExtData>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
24
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 4:
The example data below will process a credit card Void
transaction through the payment server. The PN Ref parameter should be changed
when testing this example yourself. Note: pass the card number and ExpDate
with null values on voids Parameter Value UserName test Password 123 TransType Void PNRef 2308 Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><AuthCode>V I T A L4
</AuthCode> <PNRef>2309</PNRef>
</Response>
E xample 5:
The example data below will process a credit card Force
(PostAuth) transaction through the payment server using Training Mode. The
PN Ref parameter should be changed when testing this example yourself.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
25
One Solution. Higher Profits
PayLeap Transaction API Guide
Parameter Value UserName test Password 123 TransType Force NameOnCard John Doe Amount 1.00 PNRef 2310 ExtData <TrainingMode>T</TrainingMode> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><AuthCode>D E M O2</AuthCode><PNRef>2318</PNRef>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
26
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 6:
The example data below will process a manually-entered credit
card Force (ForceAuth) transaction through the payment server.
Parameter Value UserName test Password 123 TransType Force CardNum 5454545454545454 ExpData 0509 NameOnCard John Doe Amount 1.00 ExtData <AuthCode>123456</AuthCode> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V
A L</Message><AuthCode>123456</AuthCode><PNRef>2317</PNRef><GetC
ommercialCard>F alse</GetCommercialCard><ExtData>C ard T ype= M AST E R
C A R D</ExtData>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
27
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 7:
The example data below will process a credit card C apture
transaction through the payment server to settle a single transaction in the current
batch. The PN Ref parameter should be changed when testing this example
yourself.
Parameter Value UserName test Password 123 TransType Capture PNRef 2327 Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A C C E P T E
D</Message><AuthCode>G B00029
A C C E P T E D</AuthCode><ExtData>Net_Count=1,Net_A mount=1,Settle_D T
=2004-04-13 15:36:26</ExtData>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
28
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 8:
The example data below will process a credit card C apture A ll
transaction through the payment server to settle all transactions in the current
batch.
Parameter Value UserName test Password 123 TransType CaptureAll Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A C C E P T E
D</Message><AuthCode>G B00030
A C C E P T E D</AuthCode><ExtData>Net_Count=1,Net_A mount=1,Settle_D T
=2004-04-13 15:42:45</ExtData>
</Response>
E xample 9. This example illustrates the new command ADJUSTMENT that can
modify an original Sale transaction specific to tip adjustment. This is applicable
to all restaurant supported processors. This sample starts with an original sale
amount with no tip added in the Ext Data field using HTTP POST
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
29
One Solution. Higher Profits
PayLeap Transaction API Guide
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
30
One Solution. Higher Profits
PayLeap Transaction API Guide
Response:
<?xml version="1.0" encoding="utf-8" ?>
- <Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result>
<RespMSG>A pproved</RespMSG>
<Message>N O M A T C H</Message>
<AuthCode>T AS770</AuthCode>
<PNRef>27722</PNRef>
<HostCode>704623500829</HostCode>
<GetAVSResult>N</GetAVSResult>
<GetAVSResultTXT>No M atch</GetAVSResultTXT>
<GetStreetMatchTXT>No M atch</GetStreetMatchTXT>
<GetZipMatchTXT>No M atch</GetZipMatchTXT>
<GetCommercialCard>F alse</GetCommercialCard>
<ExtData>C ard T ype= M AST E R C A R D</ExtData> </Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
31
One Solution. Higher Profits
PayLeap Transaction API Guide
To add a tip to this original Sale transaction, the command A DJUST M E N T is
used along with the username, password, PNR E F of the original sale and tip
amount in the extended data field as shown below.
Currently only the tip amount is adjustable. Please observe the screenshot
below there is no need to resend all the credit card information data to perform
a tip adjustment.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
32
One Solution. Higher Profits
PayLeap Transaction API Guide
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
33
One Solution. Higher Profits
PayLeap Transaction API Guide
<?xml version="1.0" encoding="utf-8" ?>
- <Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result>
<RespMSG>A pproved</RespMSG>
<Message>A PPR O V A L</Message>
<PNRef>27723</PNRef>
<GetCommercialCard>F alse</GetCommercialCard>
</Response>
ProcessDebitCard
This Web service operation processes debit card transactions for a merchant. The
URL to access this Web service is:
https://uat.payleap.com/TransactServices.svc/ProcessDebitCard
Descriptions of the parameters are listed below.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
34
One Solution. Higher Profits
PayLeap Transaction API Guide
Parameter Value UserName Required. User name assigned in the payment server Password Required. Password for the user name assigned in the payment server Required. Type of the debit card transaction. Valid values are: x Sale to make a purchase on a debit card x Return WRFUHGLWWKHFDUGKROGHU¶VDFFRXQW TransType x Capture to settle a single transaction in the current batch;; only for terminal-­based processors x CaptureAll to settle all transactions in the current batch;; only for terminal-­based processors or host-­based processors that support a batch release feature CardNum Required except for Capture and CaptureAll. Debit card number to process the transaction ExpDate Required except for Capture and CaptureAll'HELWFDUG¶V
expiration date in MMYY format MagData Required except for Capture and CaptureAll;; required for all swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-­Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678 NameOnCard Optional, depending on different merchant processor setup. The FDUGKROGHU¶VQDPHDVLWDSSHDUVRQWKHFDUG This parameter will © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
35
One Solution. Higher Profits
PayLeap Transaction API Guide
remove invalid characters. See list of Removed Characters for more details Amount Required except for CaptureAll. The total transaction amount in DDDD.CC format. This amount includes CashBackAmt and SureChargeAmt InvNum Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details PNRef Optional except for Force and Capture. The reference number assigned by the payment server Pin RegisterNum Required except for Capture and CaptureAll transactions and PIN-­less debit transactions. The encrypted pin block returned by the pin-­pad. The transaction will fail if an unencrypted pin value is used Optional. A number uniquely identifies the register or computer on which the transaction is performed. This parameter will remove invalid characters. See list of Removed Characters for more details SureChargeAmt Optional. The amount in DDDD.CC format that a merchant charges for processing a debit card transaction CashBackAmt Optional. The amount in DDDD.CC format that a cardholder requests for cash back Optional, except for <KeySerialNumber>, which is required for all non-­PIN-­less Sale, and Return debit transactions, and Extended data in XML format. Valid values are: ExtData x <TimeOut>TimeOut</TimeOut > for timeout value in seconds (default = 40) x <TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode;; either T or F x <KeySerialNumber>KeySerialNumber</ KeySerialNumber © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
36
One Solution. Higher Profits
PayLeap Transaction API Guide
> for managing DUKPT pin-­pads for non-­PIN-­less debit transactions ™
<Items> Items included in invoice. Contains one or more <Item> elements ¾
¾
™
<Item> One item in invoice (item details nested within). There may be multiple <Item> nested within <Items> tag ƒ
<SKU>SKU</SKU> SKU number of item ƒ
<Description>Description</Description> Item description ƒ
<DiscountAmt>DiscountAmount</DiscountAmt> Possible discount amount on item ƒ
<TaxAmt>TaxAmt</TaxAmt> Possible tax amount on item ƒ
<TotalAmt>TotalAmt</TotalAmt> Total amount of item ƒ
<TaxRate>TaxRate</TaxRate> Possible tax rate applied to item </Item> </Items> E xamples
The following tables contain sample data you can use to test this Web service.
The User Name, Password, Pin, and K eySerialNumber parameters should be
changed when testing the examples yourself.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
37
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 1:
The example data below will process a swiped debit card Sale
transaction through the payment server.
Parameter Value UserName test Password 123 TransType Sale CardNum 4055011111111111 ExpDate 1205 MagData 4055011111111111=05121015432112345678 NameOnCard John Doe Amount 1.00 InvNum 1001 Pin CashBackAmt ExtData 6366C0466A74C3F6 0.5 <Timeout>100</Timeout><KeySerialNumber>4A003102930003
BB</KeySerialNumber> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
38
One Solution. Higher Profits
PayLeap Transaction API Guide
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V A L
V I T A L7</Message><AuthCode>V I T A L7</AuthCode><PNRef>2428</PNRef
><ExtData>InvNum=1001, C ard T ype=D E B I T</ExtData>
</Response>
E xample 2:
The example data below will process a swiped debit card Return
transaction through the payment server. The PN Ref parameter should be
changed when testing this example yourself.
Parameter Value UserName test Password 123 TransType Return CardNum 4055011111111111 ExpDate 1205 MagData 4055011111111111=05121015432112345678 Amount 1.00 PNRef 2428 Pin ExtData 6366C0466A74C3F6 <KeySerialNumber>4A003102930003BB</KeySerialNumber> Result:
<?xml version="1.0" encoding="utf-8" ?>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
39
One Solution. Higher Profits
PayLeap Transaction API Guide
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>A PPR O V A L
V I T A L9</Message><AuthCode>V I T A L9</AuthCode><PNRef>2430</PNRef
><ExtData>C ard T ype=D E B I T</ExtData>
</Response>
ProcessE B T Card
This Web service operation processes EBT card transactions for a merchant. The
URL to access this service is:
https://uat.payleap.com/TransactServices.svc/ProcessEBTCard
Descriptions of the parameters are listed below.
Parameter Value UserName Required. User name assigned in the payment server Password Required. Password for the user name assigned in the payment server Required. Type of the EBT card transaction. Valid values are: TransType x FoodStampSale WRPDNHDSXUFKDVHRQDQ(%7FDUGKROGHU¶V
food stamp account x FoodStampReturn WRFUHGLWWRDQ(%7FDUGKROGHU¶VIRRG
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
40
One Solution. Higher Profits
PayLeap Transaction API Guide
stamp account x CashBenefitSale WRPDNHDSXUFKDVHRQDQ(%7FDUGKROGHU¶V
cash benefit account x Inquire to check the balance on an EBT card x Capture to settle a single transaction in the current batch;; only for terminal-­based processors x CaptureAll to settle all transactions in the current batch;; only for terminal-­based processors or host-­based processors that support a batch release feature CardNum Required except for Capture and CaptureAll. EBT card number to process the transaction ExpDate Required except for Capture and CaptureAll(%7FDUG¶V
expiration date in MMYY format MagData Optional. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-­Present transaction and usually result in a favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678 NameOnCard Optional, depending on different merchant processor setup. The FDUGKROGHU¶VQDPHDVLWDSSHDUVRQWKHFDUG Amount Required except for CaptureAll. The total transaction amount in DDDD.CC format. This amount includes CashBackAmt and SureChargeAmt InvNum Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
41
One Solution. Higher Profits
PayLeap Transaction API Guide
PNRef Optional except for FoodStampReturn and Capture. The reference number assigned by the payment server Pin Required except for Capture and CaptureAll. The encrypted pin block returned by the pin-­pad. The transaction will fail if an unencrypted pin value is used RegisterNum Optional. A number uniquely identifies a register or computer, on which the transaction is performed. This parameter will remove invalid characters. See list of Removed Characters for more details SureChargeAmt CashBackAmt Optional. The amount in DDDD.CC format that a merchant charges for processing an EBT card transaction Optional. The amount in DDDD.CC format that a cardholder requests for cash back. If used, only good for TransType of CashBenefitSale Optional except for <KeySerialNumber>, which is required for FoodStampSale, FoodStampReturn, CashBenefitSale, and Inquire with DUKPT pin-­pad setup. Extended data in XML format. Valid values are: x <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 40) ExtData x <TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode;; either T or F x <KeySerialNumber>KeySerialNumber</KeySerialNumber > for managing DUKPT pin-­pads for EBT transactions x <Force>Force</Force> for forcing duplicate transactions to be processed;; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
42
One Solution. Higher Profits
PayLeap Transaction API Guide
The following tables contain sample data you can use to test this Web service.
The User Name, Password, Pin, and K eySerialNumber parameters should be
changed when testing the examples yourself.
E xamples
E xample 1:
The example data below will process a swiped EBT card
FoodStampSale transaction through the payment server.
Parameter Value UserName test Password 123 TransType FoodStampSale CardNum 4055011111111111 ExpDate 1205 MagData 4055011111111111=05121015432112345678 Amount 10.00 Pin ExtData 6366C0466A74C3F6 <KeySerialNumber>4A003102930003BB</KeySerialNumber> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
43
One Solution. Higher Profits
PayLeap Transaction API Guide
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>FoodStam
pBalance A mount:
6543.21</Message><AuthCode>V I T A L1</AuthCode><PNRef>2431</PNRef>
<ExtData>C ard T ype= E B T</ExtData>
</Response>
E xample 2: The example data below will process a manually entered EBT card
FoodStampReturn transaction through the payment server. The PN Ref
parameter should be changed when testing this example yourself.
Parameter Value UserName test Password 123 TransType FoodStampReturn CardNum 4055011111111111 ExpDate 1205 Amount 10.00 PNRef 2459 Pin ExtData 6366C0466A74C3F6 <KeySerialNumber>4A003102930003BB</KeySerialNumber> The following is the result from using the Web service with the above sample
data.
<?xml version="1.0" encoding="utf-8" ?>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
44
One Solution. Higher Profits
PayLeap Transaction API Guide
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>
FoodStampBalance A mount:
6543.21</Message><AuthCode>V I T A L6</AuthCode><PNRef>2460</PNRef>
<ExtData>C ard T ype= E B T</ExtData>
</Response>
E xample 3:
The example data below will process a manually entered EBT
card C ashBenefitSale transaction through the payment server.
Parameter Value UserName test Password 123 TransType CashBenefitSale CardNum 4055011111111111 ExpDate 1205 Amount 10.00 InvNum 1002 Pin CashBackAmt ExtData 6366C0466A74C3F6 5 <KeySerialNumber>4A003102930003BB</KeySerialNumber> Result:
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
45
One Solution. Higher Profits
PayLeap Transaction API Guide
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><RespMSG>A pproved</RespMSG><Message>C ashBenef
itBalance A mount:
1234.56</Message><AuthCode>V I T A L8</AuthCode><PNRef>2461</PNRef>
<ExtData>C ard T ype= E B T</ExtData>
</Response>
ProcessGiftCard
This Web service operation processes gift card transactions for a merchant. The
URL to access this Web service is:
https://uat.payleap.com/TransactServices.svc/ProcessGiftCard
Descriptions of the parameters are listed below.
Parameter Value UserName Required. User name assigned in the payment server Password Required. Password for the user name assigned in the payment server © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
46
One Solution. Higher Profits
PayLeap Transaction API Guide
Required. Type of the gift card transaction. Valid values are: x Redeem to make a purchase on a gift card x Reload to increase the balance on a gift card x Refund to refund money back to a gift card x Activate to activate a gift card x Deactivate to deactivate a gift card TransType x Inquire to check the balance on a gift card x Void to undo an unsettled transaction x Force to place a transaction not processed through the payment server into the current batch (ForceAuth). Currently only available through Paymentech x Capture to settle a single transaction in the current batch;; only for terminal-­based processors x CaptureAll to settle all transactions in the current batch or host-­
based processors that support a batch release feature CardNum Required. Gift card number used to process the transaction ExpDate 5HTXLUHG*LIWFDUG¶VH[SLUDWLRQGDWHLQ00<<IRUPDW MagData Optional except when processing swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-­Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678 Amount Required except for TransType with Inquire. The total transaction © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
47
One Solution. Higher Profits
PayLeap Transaction API Guide
amount in DDDD.CC format InvNum Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details PNRef Optional except for TransType with Void. Reference number assigned by the payment server of a previous gift card transaction Optional. Extended data in XML format. Valid values are: x <TrainingMode>TrainingMode</TrainingMode> for Training Mode in either T or F x <Force>Force</Force> for forcing duplicate transactions to be processed;; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction x <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 40) x <RegisterNum>RegisterNum</RegisterNum> for register number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details ExtData x <ForceAuth>Force</ForceAuth> For previously authorized Paymentech transactions of type Redeem, Reload, and Activate to place these transactions into the current batch. (See hierarchy below) Currently only available through Paymentech. See Examples 2 and 3 below x <AuthCode>AuthCode</AuthCode> Required for Paymentech transactions of type Force (Redeem ForceAuth) See hierarchy below. The authorization code previously obtained for the transaction. Currently only available through Paymentech ™
<ForceAuth> ¾
<AuthCode>AuthCode</AuthCode> Required for Paymentech transactions being processed using © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
48
One Solution. Higher Profits
PayLeap Transaction API Guide
<ForceAuth> (placed within <ForceAuth> tag). The authorization code previously obtained for the transaction. Currently only available through Paymentech ™
</ForceAuth> G ift C ard Force A uth T ransactions
When processing gift cards through Paymentech, it is possible to do a transaction
of type Force (a Redeem ForceAuth, for example after a phone authorization is
obtained for a purchase) in order to place a gift card Redeem transaction in the
current batch. Such a transaction requires <A uth Code> to be passed in ExtData
(See above table and see Example 2 below).
It is also possible to place previously authorized transactions of type Redeem,
Reload, and A ctivate in the current batch using the <Force A uth> tag with
<A uth Code> nested inside (See above table and see Examples 3 and 4 below).
Essentially, that means that a Redeem can be forced into the batch in two
different ways, whereas the Reload and A ctivate types must be placed in the
batch through the second method. Please note that Gift Card ForceAuth
transactions are only required to place a previously authorized Redeem, Reload,
or A ctivate in the current batch.
E xamples
The following tables contain sample data to process gift card transactions
through the payment server. The User Name and Password parameters should
be changed when testing the example yourself.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
49
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 1: The example data below will process a Redeem transaction on a gift
card through the payment server.
Parameter Value UserName test Password 123 TransType Redeem CardNum 6032250001350000156 ExpDate 0509 MagData 6032250001350000156=09051015432112345678 Amount 10.00 InvNum 1001 ExtData <Force>T</Force> Result:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><Message>G ift C ardBalance A mount:
10.00</Message><PNRef>2355</PNRef><HostCode>100004389913</HostCod
e><ExtData>InvNum=1001, C ard T ype= E G C</ExtData>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
50
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 2:
The example data below will process a swiped gift card Force
transaction through the payment server. The AuthCode value should be changed
when testing this example yourself.
Parameter Value UserName test Password 123 TransType Force CardNum 6035718888880552378 ExpDate 1210 MagData 6035718888880552378=1012000876414 NameOnCard John Doe Amount 3.00 ExtData <AuthCode>104013</AuthCode> Result:
<?xml version="1.0" encoding="utf-8" ?>
- <Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><Message>A PPR O V E D</Message><AuthCode>104013</
AuthCode><PNRef>39782</PNRef><HostCode>00000014</HostCode><ExtD
ata>C ard T ype= E G C</ExtData></Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
51
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 3:
The example data below will place a gift card Redeem
transaction into the current batch. The AuthCode value should be changed when
testing this example yourself.
Parameter Value UserName test Password 123 TransType Redeem CardNum 6035718888880552378 ExpDate 1210 NameOnCard John Doe Amount 3.00 ExtData <ForceAuth><AuthCode>105258</AuthCode></ForceAuth> <?xml version="1.0" encoding="utf-8" ?>
- <Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><Message>A PPR O V E D</Message><AuthCode>105259</
AuthCode><PNRef>39783</PNRef><HostCode>00000015</HostCode><ExtD
ata>C ard T ype= E G C</ExtData>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
52
One Solution. Higher Profits
PayLeap Transaction API Guide
E xample 4:
The example data below will place a gift card Reload transaction
into the current batch. The AuthCode value should be changed when testing this
example yourself.
Parameter Value UserName test Password 123 TransType Reload CardNum 6035718888880552378 ExpDate 1210 NameOnCard John Doe Amount 20.00 ExtData <ForceAuth><AuthCode>105260</AuthCode></ForceAuth> <?xml version="1.0" encoding="utf-8" ?>
- <Response xmlns:xsd="http://www.w3.org/2001/X M LSchema"
xmlns:xsi="http://www.w3.org/2001/X M LSchema-instance"
xmlns="http://www.payleap.com/payments">
<Result>0</Result><Message>A PPR O V E D</Message><AuthCode>105261</
AuthCode><PNRef>39784</PNRef><HostCode>00000016</HostCode>
<ExtData>C ard T ype= E G C</ExtData>
</Response>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
53
One Solution. Higher Profits
PayLeap Transaction API Guide
ValidCard
This Web service operation does the validation check on a credit card. It checks
the card length based on the card type, performs a mod 10 checksum, and checks
the expiration date. The return value could be: 0 ± good, 1001 ± no card number,
1002 ± no expiration date, 1003 ± invalid card type, 1004 ± invalid card length,
1005 ± invalid mod 10 check, 1006 ± invalid expiration date. The URL to access
this operation is:
7KHWH[W³WHVWSD\OHDSFRP´LQWKH85/VKRXOGEHUHSODFHGZLWKWKHDFWXDOKRVW
name or static IP address of the payment server. Descriptions of the parameters
are listed below.
Parameter CardNumber ExpDate Description Required. The number of a credit card Required. The expiration date of a credit card E xamples
The following tables contain sample data you can use to test this Web service.
E xample 1:
Parameter CardNumber ExpDate The example data below will result in return 0.
Value 5454545454545454 0509 © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
54
One Solution. Higher Profits
PayLeap Transaction API Guide
Result:
<?xml version="1.0" encoding="utf-8" ?>
<int xmlns="http://www.payleap.com/payments">0</int>
E xample 2:
The example data below will result in return 1005.
Parameter CardNumber ExpDate Value 5454545454545453 0509 Result:
<?xml version="1.0" encoding="utf-8" ?>
<int xmlns="http://www.payleap.com/payments">1005</int>
ValidCardLength
This Web service operation checks for the card length based on the card type.
The URL to access this operation is:
https://uat.payleap.com/TransactServices.svc/
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
55
One Solution. Higher Profits
PayLeap Transaction API Guide
Descriptions of the parameters are listed below.
Parameter CardNumber Description Required. The number of a credit card E xamples
The following tables contain sample data you can use to test this Web service.
The return result will be either true or false.
E xample 1:
Parameter CardNumber The example data below will result in return false.
Value 54545454545454 Result:
<?xml version="1.0" encoding="utf-8" ?>
<boolean xmlns="http://www.payleap.com/payments">false</boolean>
E xample 2:
Parameter CardNumber The example data below will result in return true.
Value 4126196901499 Result:
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
56
One Solution. Higher Profits
PayLeap Transaction API Guide
<?xml version="1.0" encoding="utf-8" ?>
<Boolean xmlns="http://www.payleap.com/payments">true</boolean>
ValidE xpDate
This Web service operation validates the expiration date of a credit card. The
URL to access this operation is:
https://uat.payleap.com/TransactServices.svc/
Descriptions of the parameters are listed below.
Parameter ExpDate Description Required. The expiration date of a credit card E xamples
The following tables contain sample data you can use to test this Web service.
The return value will either be true or false.
E xample 1:
Parameter ExpDate The example data below will result in return true.
Value 0509 Result:
<?xml version="1.0" encoding="utf-8" ?>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
57
One Solution. Higher Profits
PayLeap Transaction API Guide
<boolean xmlns="http://www.payleap.com/payments">true</boolean>
E xample 2:
Parameter ExpDate The example data below will result in return false.
Value 0304 Result:
<?xml version="1.0" encoding="utf-8" ?>
<boolean xmlns="http://www.payleap.com/payments">false</boolean>
ValidMod10
This Web service operation validates the credit card by performing a mod 10
checksum on the card number. The URL to access this operation is:
https://uat.payleap.com/TransactServices.svc/
Descriptions of the parameters are listed below. Parameter CardNumber Description Required. The number of a credit card © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
58
One Solution. Higher Profits
PayLeap Transaction API Guide
E xamples
The following table contains sample data you can use to test this Web service.
The return result will be either true or false.
E xample 1:
Parameter CardNumber The example data below will result in return true.
Value 54545454545454 Result:
<?xml version="1.0" encoding="utf-8" ?>
<boolean xmlns="http://www.payleap.com/payments">true</boolean>
E xample 2:
Parameter CardNumber The example data below will result in return false.
Value 545454545454 Result:
<?xml version="1.0" encoding="utf-8" ?>
<boolean xmlns="http://www.payleap.com/payments">false</boolean>
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
59
One Solution. Higher Profits
PayLeap Transaction API Guide
W eb Service Response F ields
Response Field Data Type Value Description AuthCode ExtData A string value up to 50 characters GetAVS ResultTXT Get CommercialC
ard Returns the transaction result code from the payment processor This value can be either an approval code, for approved transactions, or an error code, for declined transactions Returns extra data from the processed transaction The value of ExtData will be in a specific format. The format typically consists of the name of the data field, an equal sign, and then the value for the data field. Multiple data fields are separated ZLWKDFRPPD6HHWKH³:HE
Service ExtData Response Field 'DWD(OHPHQWV´IRUIXOOGHVFULSWLRQ
of data elements that can be returned. The following is an example of the format: ExtName1=ExtValue1,ExtName2=
ExtValue2 Returns the overall address verification result code from the payment processor When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted response message describing the result A string value up to 500 characters A string value up GetAVSResult to 1 character Returns the A string formatted response value up message when to 25 address verification characters is performed A string value representi
ng a Remarks Returns the payment processor's response indicator Do NOT use this when programmatically validating a WUDQVDFWLRQ¶V$96UHVXOWSOHDVH
see GetAVSResult field This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
60
One Solution. Higher Profits
PayLeap Transaction API Guide
Boolean value that specifies if the card is a commercial card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result Returns the card verification result code from the payment processor This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result Returns the formatted response message when card verification is performed This value is only applicable to credit card transactions. Do NOT use this when programmatically YDOLGDWLQJDWUDQVDFWLRQ¶V&9
result;; please see GetCVResult field GetCVResult A string value up to 1 character GetCVResultT
XT A string value up to 25 characters GetStreetMat
chTXT A string value up to 25 characters Returns the formatted response message when street number address verification is performed This value will typically be ³0DWFK´IRUFRUUHFWO\PDWFKLQJ
WKHVWUHHWDGGUHVVRU³1R0DWFK´
for an incorrect street address GetZipMatchT
XT A string value up Returns the formatted response This value will typically be ³0DWFK´IRUFRUUHFWO\PDWFKLQJ
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
61
One Solution. Higher Profits
PayLeap Transaction API Guide
to 25 message when zip characters code address verification is performed HostCode A string value up to 30 characters WKH]LSFRGHRU³1R0DWFK´IRUDQ
incorrect zip code Typically returns a number which uniquely identifies the transaction in the payment processor This value may not be returned for all payment processors Returns a formatted response message concerning the processed transaction This value will typically be ³$33529$/´IRUDSSURYHG
transactions, or an error message, for declined transactions. Do NOT use this when programmatically YDOLGDWLQJDWUDQVDFWLRQ¶VUesult;; please see Result field below Message A string value up to 50 characters Message1 A string value up to 50 characters Returns an extra formatted response message giving more information about the processed transaction The Payment Server will only populate this field when there is applicable information from the payment processor to return Message2 A string value up to 50 characters Returns an extra formatted response message giving more information about the processed transaction The Payment Server will only populate this field when there is applicable information from the payment processor to return Returns a number which uniquely identifies the transaction in the payment gateway PNRef A string value representi
ng a signed 32-­
bit integer © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
62
One Solution. Higher Profits
PayLeap Transaction API Guide
RespMSG Returns the A string response message value up concerning the to 50 processed characters transaction This value is typically either Approved or Declined. Do NOT use this when programmatically YDOLGDWLQJDWUDQVDFWLRQ¶VUHVXOW
please see Result field below Result Returns the transaction result A string code from the value payment gateway representi
which signifies the ng a result of the signed 32-­
transaction (i.e. bit integer approved, decline, etc.) When programmatically validating DWUDQVDFWLRQ¶VUHVXOWWKLVYDOXH
should ALWAYS be used instead of any response message describing WKHUHVXOW6HHWKH³5HVXOW
5HVSRQVH)LHOGV'HILQLWLRQV´
section for a full list of result values and descriptions Web Service E xtData Response F ield Data E lements
Data Element Name Value Description Remarks BatchNum Returns the current batch number, returned by the payment processor, for transactions, settlement, and batch inquiries Not all payment processors support returning this data element CardType Returns the credit card type (VISA, MASTERCARD, etc), payment method (Debit, EBT, or EGC) for card-­based payments This value is not returned for Check/ACH payments InvNum Returns the same invoice number for the transaction that was originally sent in the request to the Payment Server © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
63
One Solution. Higher Profits
PayLeap Transaction API Guide
Response V alues
Result Response F ield Definitions (E rror Codes)
The list below contains result codes returned in the Result response field of the
XMLPayResponse when using a transaction processing Transact.asmx web
service operation (i.e. ProcessCreditCard, ProcessCheck, etc). A decline returned
by the payment processor for this response field is value twelve (12) or thirteen
(13). An approval is value zero (0). Any other value is an error code, which is
returned by the payment gateway and not by the payment processor. Please note
WKDWZKHQSURJUDPPDWLFDOO\YDOLGDWLQJDWUDQVDFWLRQ¶VUHVXOWWKLVYDOXHVKRXOGEH
used instead of any response message describing the result. I.e. do not use
RespMSG or Message response fields, as these values may vary. Please note that
this list is subject to change without prior notice.
Value Description -­100 Transaction NOT Processed;; Generic Host Error 0 Approved 1 User Authentication Failed 2 Invalid Transaction 3 Invalid Transaction Type 4 Invalid Amount 5 Invalid Merchant Information 7 Field Format Error 8 Not a Transaction Server © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
64
One Solution. Higher Profits
PayLeap Transaction API Guide
9 Invalid Parameter Stream 10 Too Many Line Items 11 Client Timeout Waiting for Response 12 Decline 13 Referral 14 Transaction Type Not Supported In This Version 19 Original Transaction ID Not Found 20 Customer Reference Number Not Found 22 Invalid ABA Number 23 Invalid Account Number 24 Invalid Expiration Date 25 Transaction Type Not Supported by Host 26 Invalid Reference Number 27 Invalid Receipt Information 28 Invalid Check Holder Name 29 Invalid Check Number 30 Check DL Verification Requires DL State 40 Transaction did not connect (to NCN because SecureNCIS is not running on the web server) 50 Insufficient Funds Available © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
65
One Solution. Higher Profits
PayLeap Transaction API Guide
99 General Error 100 Invalid Transaction Returned from Host 101 Timeout Value too Small or Invalid Time Out Value 102 Processor Not Available 103 Error Reading Response from Host 104 Timeout waiting for Processor Response 105 Credit Error 106 Host Not Available 107 Duplicate Suppression Timeout 108 Void Error 109 Timeout Waiting for Host Response 110 Duplicate Transaction 111 Capture Error 112 Failed AVS Check 113 Cannot Exceed Sales Cap 1000 Generic Host Error 1001 Invalid Login 1002 Insufficient Privilege or Invalid Amount 1003 Invalid Login Blocked 1004 Invalid Login Deactivated © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
66
One Solution. Higher Profits
PayLeap Transaction API Guide
1005 Transaction Type Not Allowed 1006 Unsupported Processor 1007 Invalid Request Message 1008 Invalid Version 1010 Payment Type Not Supported 1011 Error Starting Transaction 1012 Error Finishing Transaction 1013 Error Checking Duplicate 1014 No Records To Settle (in the current batch) 1015 No Records To Process (in the current batch) A VS Response Codes
The following table contains the possible response values returned for address
verification (AVS).
Value Description X Exact: Address and nine-­digit Zip match Y Yes: Address and five-­digit Zip match A Address: Address matches, Zip does not Z 5-­digit Zip: 5-­GLJLW=LSPDWFKHVDGGUHVVGRHVQ¶W © 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
67
One Solution. Higher Profits
PayLeap Transaction API Guide
W Whole Zip: 9-­GLJLW=LSPDWFKHVDGGUHVVGRHVQ¶W N No: Neither address nor Zip matches U Unavailable: Address information not available G Unavailable: Address information not available for international transaction R Retry: System unavailable or time-­out E Error: Transaction unintelligible for AVS or edit error found in the message that prevents AVS from being performed S 1RW6XSSRUWHG,VVXHUGRHVQ¶WVXSSRUW$96VHUYLFH B * Street Match: Street addresses match for international transaction, but SRVWDOFRGHGRHVQ¶W C * Street Address: Street addresses and postal code not verified for international transaction D * Match: Street addresses and postal codes match for international transaction I * Not Verified: Address Information not verified for International transaction M * Match: Street addresses and postal codes match for international transaction P * Postal Match: Postal codes match for international transaction, but street DGGUHVVGRHVQ¶W 0 ** No response sent 5 Invalid AVS response * These values are Visa specific.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
68
One Solution. Higher Profits
PayLeap Transaction API Guide
** These values are returned by the Payment Server and not the processor.
C V Response Codes
The following table contains the possible response values returned for a
CVV2/CVC2/CID check.
Value Description M CVV2/CVC2/CID Match N CVV2/CVC2/CID No Match P Not Processed S Issuer indicates that the CV data should be present on the card, but the merchant has indicated that the CV data is not present on the card. U Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard with the CV encryption keys. X Server Provider did not respond V alid Parameter Input C haracters
The table below displays all allowable characters (unless otherwise noted) that
are accepted by the Payment Server. Characters are displayed in Courier New
font. All other characters may cause undesirable results.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
69
One Solution. Higher Profits
PayLeap Transaction API Guide
Table 1. Valid Data Characters
D H Char E E
C X D H Char E E
C X D H
E E
C X Char 3 2
2 0 Space 6 3
3 F ? 9 6
6 0 ` 3 2
3 1 ! 6 4
4 0 @ 9 6
7 1 a 3 2
4 2 " 6 4
5 1 A 9 6
8 2 b 3 2
5 3 # 6 4
6 2 B 9 6
9 3 c 3 2
6 4 $ 6 4
7 3 C 1 6
0 4 0 d 3 2
7 5 % 6 4
8 4 D 1 6
0 5 1 e 3 2
8 6 & 6 4
9 5 E 1 6
0 6 2 f 3 2
9 7 ' 7 4
0 6 F 1 6
0 7 3 g 4 2
0 8 ( 7 4
1 7 G 1 6
0 8 4 h 4 2
1 9 ) 7 4
2 8 H 1 6
0 9 5 i 4 2
2 A * 7 4
3 9 I 1 6
0 A 6 j 4
+ 7
J 1
k 2
4
6
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
70
One Solution. Higher Profits
PayLeap Transaction API Guide
3 B 4 A 0 B 7 4 2
4 C , 7 4
5 B K 1 6
0 C 8 l 4 2
5 D -­ 7 4
6 C L 1 6
0 D 9 m 4 2
6 E . 7 4
7 D M 1 6
1 E 0 n 4 2
7 F / 7 4
8 E N 1 6
1 F 1 o 4 3
8 0 0 7 4
9 F O 1 7
1 0 2 p 4 3
9 1 1 8 5
0 0 P 1 7
1 1 3 q 5 3
0 2 2 8 5
1 1 Q 1 7
1 2 4 r 5 3
1 3 3 8 5
2 2 R 1 7
1 3 5 s 5 3
2 4 4 8 5
3 3 S 1 7
1 4 6 t 5 3
3 5 5 8 5
4 4 T 1 7
1 5 7 u 5 3
4 6 6 8 5
5 5 U 1 7
1 6 8 v 5
7 8
V 1
w 3
5
7
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
71
One Solution. Higher Profits
PayLeap Transaction API Guide
5 7 6 6 1 7 9 5 3
6 8 8 8 5
7 7 W 1 7
2 8 0 x 5 3
7 9 9 8 5
8 8 X 1 7
2 9 1 y 5 3
8 A : 8 5
9 9 Y 1 7
2 A 2 z 5 3
9 B ;; 9 5
0 A Z 1 7
2 B 3 { 6 3
0 C < 9 5
2 C \ 1 7
2 C 4 | 6 3
1 D = 9 5
4 E ^ 1 7
2 D 5 } 6 3
2 E > 9 5
5 F _ 1 7
2 E 6 ~ C haracter Removal
The table below displays all acceptable characters that must be removed by the
Payment Server before submitting information to the Web Service operations.
See each input parameter for each Web Service operation in order to know which
input parameters will have these characters removed. This character removal
HQVXUHVWKDWWKH3D\PHQW6HUYHUV¶LQWHUQDO;0/SDUVHUVFDQSURSHUO\UHDGWKH
information of the Web Service operation. Characters in the table are displayed
in Courier New font.
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
72
One Solution. Higher Profits
PayLeap Transaction API Guide
Many XML Parsers will encode these characters for you. In this case, the
characters will not be converted back to their proper values by the Payment
Server; they will be taken literally. Also, if you pass the encoded character
through an input parameter that removes the characters listed in the table below,
then certain characters may be removed (see examples below). However, if you
are not using a parser, or if the parser does not handle this encoding, then the
characters in the table listed below may still be removed, depending on the input
parameter for the Web Service operation you are using.
Table 2. X M L Character Removal
Character < XML Parser Encoding &lt;; > &gt;; & &amp;; ' &apos;; " &quot;; E xample
The following example shows how characters would be removed if the data was
passed through the NameOnCard parameter of the ProcessCreditCard operation.
Valid: John James
Invalid: John & James becomes John James
Invalid: John &amp; James becomes John amp; James
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
73