PayLeap Transaction API Guide |
Welcome
Thank you for choosing PayLeap as your preferred Payment
Gateway solution.
The Transaction API Guide contains all of the necessary resources
to integrate the PayLeap Payment Gateway specifications into a website,
ecommerce application, or POS system for transaction processing. All API documentation and Sample Source
Code is located at http://www.payleap.com/developers.html
PayLeap is committed to
providing the highest quality support. If you have any questions, comments, or
suggestions please contact PayLeap:
Web: http://www.payleap.com/support.html
Email:
support@payleap.com
Phone: 866-267-9609
Corporate
Headquarters:
|
3594
E US HWY 30 |
|
Warsaw,
IN 46580 |
License Information
Disclaimer
The PayLeap and supporting services are licensed on
an “as is” basis. There
are no warranties, expressed or implied, including, but not limited to, warranties
of merchantability or of fitness for a particular purpose, and all such
warranties are expressly and specifically disclaimed. PayLeap shall have no liability or responsibility
to you nor any other person or entity with respect to any liability, loss, or
damage caused or alleged to be caused directly or indirectly by any PayLeap software and supporting services. Use of the PayLeap software and supporting services
signifies agreement with this disclaimer and is subject to the license
agreement provided with the installation of the software.
Restricted
Use
Copying
of the manual, interface specifications, or system files for use other than
backing up files and/or to connect to systems other than the PayLeap
Payment Gateway or your processor is prohibited. You may not remove any product
identification, copyright, or other proprietary notices from the software or
documentation. Reverse engineering
is strictly prohibited.
The
PayLeap Application is provided for use in connecting with the PayLeap
Payment Gateway.
Use of any components, code, or documentation to connect to other systems is
strictly prohibited and a violation of this agreement and subject to all
remedies available by law.
Overview
Test Environment
If you would
like a PayLeap Test Account please visit our support page to request one: http://www.payleap.com/support.html
The Test
Environment Merchant Interface can be accessed at http://test.payleap.com.
|
Test Card Information |
|
|
American
Express |
374255312721002 |
|
Diners
Club |
36999999999999 |
|
Discover |
60011111111111117 |
|
MasterCard |
5000300020003003 |
|
Visa |
4005550000000019 |
|
Electronic
Check |
Routing
Number: 123123123 Account
Number: 111111111111 |
Test Transaction Examples
These are preconfigured
examples with sample data. You can
insert your PayLeap Test Account User Name and Password in the appropriate
fields for submitting test transactions and viewing the Test Server Responses.
|
All Web Service Operation Details are located in there
appropriate section in this guide |
|
|
Processes Electronic Check |
|
|
Processes Credit Card |
|
|
Processes Debit Card |
|
|
Processes EBT Card |
|
|
Processes Gift Card |
|
|
Processes Loyalty Card |
|
|
Sends a Signature to apply to transaction
receipt |
|
|
Validates Credit Card by performing Mod10
checksum based on Card Type.
Validates Expiration Date. |
|
Web
Service Operation Details
|
ProcessCheck URL |
|
|
Production Server |
https://secure.payleap.com/SmartPayments/transact.asmx/ProcessCheck |
|
Test Server |
http://test.payleap.com/SmartPayments/transact.asmx/ProcessCheck |
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale Authorization and
Capture of funds Auth Authorization Only
of funds Return Issue refund of
funds. Transaction must be
settled to perform a return. Void Undo an unsettled
transaction. Force Force a previous Auth into the current batch. This will capture funds on an
Authorization Only not in the current batch. The PNRef number generated during the original Auth is required for this to function correctly. Capture Capture funds of
specific Auth transaction in
current batch. The PNRef number generated during the
original Auth is required for this
to function correctly. CaptureAll Capture All
transactions in the current batch. |
|
CheckNum |
Required
unless TransType = Void, Capture, CaptureAll. CheckNum
uniquely identifies each individual check. |
|
TransitNum |
Required unless TransType = Void,
Capture, CaptureAll. TransitNum
uniquely identifies a bank routing number. |
|
AccountNum |
Required unless TransType = Void, Capture, CaptureAll. Account
number uniquely identifies a check holder’s bank account number. |
|
Amount |
Required unless TransType = Void, Capture, CaptureAll. The total
transaction amount in DDDD.CC format. |
|
MICR |
Optional. The Magnetic Ink
Check Reader data line, which includes TransitNum,
and AccountNum. Required
for processing Check-Present transactions. |
|
NameOnCheck |
Required unless TransType = Void, Capture, CaptureAll. The
check holder’s name as it appears on the check. The parameter may be
required, depending on the merchant’s processor setup. |
|
DL |
Optional. The
check holder’s driver’s license number. |
|
SS |
Optional. The
check holder’s Social Security Number. |
|
DOB |
Optional. The
check holder’s date of birth. |
|
StateCode |
Optional. (Based on Processor) The
check holder’s 2 character state code. The parameter may be required
depending on the merchant’s processor setup. |
|
CheckType |
Optional. Type of check. Valid values: Personal,
Corporate, Government |
|
ExtData |
Extended Data in XML format ExtData field is required for ALL transactions. Value may be
left blank in most cases. Possible Processor Requirements; CityOfAccount, BillToStreet, BillToPostalCode. RawMICR
required for processing Check-Present transactions. Valid values are: <TimeOut>TimeOut</TimeOut> Timeout value in seconds (default = 30) <PNRef>PNRef</PNRef> Reference number assigned by the Payment Gateway.
This field is required for ALL transactions however a value may be left blank. <Phone>Phone</Phone> Phone Number <Email>EMail</EMail> Email Address <RawMICR>RawMICR</RawMICR> Raw Magnetic Ink Check Reader data from the check
reader in the format of: TransitNumTAccountNumOCheckNum <InvNum>InvNum</InvNum> Invoice Tracking Number <TrainingMode>TrainingMode</TrainingMode> Process Transaction in Training Mode; either T or F <AllianceNum>AllianceNum</AllianceNum> Alliance number for the check <AccountType>AccountType</AccountType> Bank Account Type for the check. Valid values are
Checking or Saving <CityOfAccount>CityOfAccount</CityOfAccount> <BillToStreet>BillToStreet</BillToStreet> Street name of the check holder's
billing address <BillToCity>BillToCity</BillToCity> City name of the check holder's billing address <BillToState>BillToState</BillToState> Two character state code of the check holder's billing
address. <BillToPostalCode>BillToPostalCode</BillToPostalCode> Zip code of the check holder's billing address. <BillToCountry>BillToCountry</BillToCountry> Country name of the check holder's billing address. <CustomerID>CustomerID</CustomerID> Customer ID for tracking purposes. |
ProcessCheck
Examples
The example parameters and values below will process a
manually entered check. This type
of example would be used for websites and ecommerce applications which are not
using a swipe terminal.
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale |
|
CheckNum |
1001 |
|
TransitNum |
123123123 |
|
AccountNum |
111111111111 |
|
Amount |
1.00 |
|
NameOnCheck |
John Doe |
|
StateCode |
WA |
|
ExtData |
<CityOfAccount>Seattle</CityOfAccount><BillToStreet>123
Street</BillToStreet><BillToPostalCode>98498</BillToPostalCode><PNRef></PNRef> |
Response Example:
<?xml version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://secure.payleap.com/SmartPayments/">
<Result>0</Result>
<RespMSG>Approved</RespMSG>
<Message>APPROVAL</Message>
<AuthCode>GUEIJQ</AuthCode>
<PNRef>2400</PNRef>
</Response>
The example parameters and values below
will process swiped check. This type
of example would be used for POS applications when a swipe terminal is
available.
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale |
|
CheckNum |
1001 |
|
TransitNum |
123123123 |
|
AccountNum |
111111111111 |
|
Amount |
1.00 |
|
NameOnCheck |
John Doe |
|
MICR |
1234567801234567890 |
|
ExtData |
<RawMICR>123456780T1234567890O1001</RawMICR><PNRef></PNRef> |
Response Example:
<?xml
version="1.0" encoding="utf-8" ?>
<Response xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://secure.payleap.com/SmartPayments/">
<Result>0</Result>
<Message>APPROVAL</Message>
<AuthCode>AUTH NUM 121-704</AuthCode>
</Response>
ProcessCreditCard
|
ProcessCreditCard URL |
|
|
Production
Server |
https://secure.payleap.com/SmartPayments/transact.asmx/ProcessCreditCard
|
|
Test
Server |
http://test.payleap.com/SmartPayments/transact.asmx/ProcessCreditCard |
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale Authorization and
Capture of funds Auth Authorization Only
of funds Return Issue refund of
funds. Transaction must be
settled to perform a return. Void Undo an unsettled
transaction. Force Force a previous Auth into the current batch. This will capture funds on an
Authorization Only not in the current batch. The PNRef number generated during the original Auth is required for this to function correctly. Capture Capture funds of
specific Auth transaction in
current batch. The PNRef number generated during the
original Auth is required for this
to function correctly. CaptureAll Capture All
transactions in the current batch. |
|
CardNum |
Optional
unless TransType = Sale, Auth, Return, Force. |
|
ExpDate |
Optional
unless TransType = Sale, Auth, Return, Force. |
|
MagData |
Field
Required. Value optional unless
processing a swiped credit card.
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. |
|
NameOnCard |
Optional,
depending on different merchant processor setups. The cardholder’s name
as it appears on the card. |
|
Amount |
Optional
unless TransType = Sale, Auth, Return, Force. |
|
InvNum |
Optional.
Invoice tracking number. |
|
Zip |
Optional
depending on different merchant processor setups. Cardholder’s billing
address zip code used in address verification. |
|
Street |
Optional
depending on different merchant processor setup. Cardholder’s billing
street address used in address verification. |
|
CVNum |
Optional.
Card verification number. |
|
ExtData |
Extended Data in XML format ExtData field is required for ALL transactions. Value may be
left blank in most cases. <PNRef>PNRef</PNRef> Reference number assigned by the Payment Gateway.
This field is required for ALL transactions however a value may be left blank. <AuthCode>ApprovalCode</AuthCode> Optional unless TransType = Force. <PONum>PONumber</PONum> Customer
PO number. <TipAmt>TipAmount</TipAmt> Tip
amount in DDDD.CC format <TaxAmt>TaxAmount</TaxAmt> Tax
amount in DDDD.CC format <SequenceNum>SequenceNum</SequenceNum> 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 <SequenceCount>SequenceCount</SequenceCount> 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 <ServerID>ServerID</ServerID> Unique
server identification number. <TimeOut>TimeOut</TimeOut> Timeout
value in seconds (default = 40) <TrainingMode>TrainingMode</TrainingMode> Process
transaction in Training Mode; either T or F <Force>Force</Force> Forcing
duplicate transactions to be processed; either T or F. Note that some
processors will not utilize this tag and may still reject a duplicate
transaction <RegisterNum>RegisterNum</RegisterNum> Register
number. <City>City</City> The
city name of the cardholder's billing address. <BillToState>State</BillToState> The two
character state code of the cardholder's billing address. <CustomerID>CustomerID</CustomerID> Customer
ID for tracking purposes <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). <EntryMode>EntryModeValue</EntryMode> Indicates
how the values for the payment information were obtained. The Valid values
for this tag are: UNKNOWN, MANUAL,MAGNETICSTRIPE,ICC, and PROXIMITY <Invoice>Invoice</Invoice> Indicates
invoice details. See below for hierarchy of elements nested within. Please
note that all elements included inside <Invoice> must be in the
specific order listed below: --BEGIN INVOICE <Invoice> <InvNum>InvNum</InvNum>
Purchase
invoice number <Date>Date</Date>
Date of
invoice. --BEGIN BILLTO <BillTo> <CustomerId>CustomerId</CustomerId>
Customer
ID number <Name>Name</Name> Customer
name --BEGIN ADDRESS <Address> <Street>Street</Street>
Customer
street <City>City</City>
Customer
city <State>State</State>
Customer
state <Zip>Zip</Zip>
Customer
zip code <Country>Country</Country>
Customer
country </Address> --END 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> --END BILLTO <Description>Description</Description> Description
of purchase --BEGIN ITEMS <Items> Items contained
in invoice. Contains one or more <Item> elements One
item in invoice (item details nested within). There may be multiple
<Item> nested within <Items> tag <Description>Description</Description> Item
description <Quantity>Quantity</Quantity> Quantity
purchased of item <UnitOfMeasurement>UnitOfMeasure</UnitOfMeasurement> Unit of
measurement for item <UnitPrice>UnitPrice</UnitPrice> Unit
price of item <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> --END ITEM <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> --END INVOICE |
ProcessCreditCard
Examples
The example parameters and values 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.
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale |
|
CardNum |
4111111111111111 |
|
ExpDate |
1112 |
|
NameOnCard |
John Doe |
|
Amount |
1.00 |
|
ExtData |
<Force>T</Force> |
|
PNRef |
|
Response
Example:
<?xml version="1.0"
encoding="utf-8" ?>
<Response
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://secure.payleap.com/SmartPayments/">
<Result>0</Result>
<RespMSG>Approved</RespMSG>
<Message>APPROVAL</Message>
<AuthCode>2296</AuthCode>
<PNRef>2296</PNRef>
<HostCode>03530EVV3K2ZA2F453Q</HostCode>
<GetAVSResult>N</GetAVSResult>
<GetAVSResultTXT>No Match</GetAVSResultTXT>
<GetStreetMatchTXT>No Match</GetStreetMatchTXT>
<GetZipMatchTXT>No Match</GetZipMatchTXT>
<GetCommercialCard>False</GetCommercialCard>
<ExtData>CardType=VISA</ExtData>
</Response>
The example parameters and values below will process a manually-entered credit card Return transaction through the payment server.
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Auth |
|
CardNum |
4111111111111111 |
|
ExpDate |
1112 |
|
NameOnCard |
John Doe |
|
Amount |
1.00 |
|
InvNum |
1002 |
|
PNRef |
2296 |
Response
Example:
<?xml version="1.0" encoding="utf-8" ?>
<Response
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://secure.payleap.com/SmartPayments/">
<Result>0</Result>
<RespMSG>Approved</RespMSG>
<Message>APPROVAL</Message>
<AuthCode>2297</AuthCode>
<PNRef>2297</PNRef>
<ExtData>InvNum=1002,CardType=VISA</ExtData>
</Response>
ProcessDebitCard
|
ProcessDebitCard URL |
|
|
Production
Server |
https://secure.payleap.com/SmartPayments/transact.asmx/ProcessDebitCard |
|
Test
Server |
http://test.payleap.com/SmartPayments/transact.asmx/ProcessDebitCard |
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale Authorization and
Capture of funds Auth Authorization Only
of funds Return Issue refund of
funds. Transaction must be
settled to perform a return. Void Undo an unsettled
transaction. Force Force a previous Auth into the current batch. This will capture funds on an
Authorization Only not in the current batch. The PNRef number generated during the original Auth is required for this to function correctly. Capture Capture funds of
specific Auth transaction in
current batch. The PNRef number generated during the
original Auth is required for this
to function correctly. CaptureAll Capture All
transactions in the current batch. |
|
CardNum |
Optional
unless TransType = Sale, Auth, Return, Force. |
|
ExpDate |
Optional
unless TransType = Sale, Auth, Return, Force. |
|
MagData |
Field
Required. Value optional unless
processing a swiped credit card.
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. |
|
NameOnCard |
Optional,
depending on different merchant processor setups. The cardholder’s name
as it appears on the card. |
|
Amount |
Optional
unless TransType = Sale, Auth, Return, Force. |
|
InvNum |
Optional.
Invoice tracking number. |
|
PNRef |
Field
Required. Value optional unless TransType = Force, Capture. The PNRef numbers is assigned by the
payment server. |
|
RegisterNum |
Optional.
A number uniquely identifies the register or computer on which the transaction
is performed. |
|
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. |
|
Zip |
Optional
depending on different merchant processor setups. Cardholder’s billing
address zip code used in address verification. |
|
Street |
Optional
depending on different merchant processor setup. Cardholder’s billing
street address used in address verification. |
|
CVNum |
Optional.
Card verification number. |
|
Pin |
Required
unless TransType = Capture, CaptureAll.
The encrypted pin block is returned by the pin-pad. The transaction will fail
if an unencrypted pin value is used |
|
ExtData |
Extended
data in XML format. ExtData
field is required for ALL transactions. Value optional, except for
<KeySerialNumber>, which is required for all non-PIN-less Sale, Auth,
Force, and Return debit transactions, and <Items> and associated nested
data elements. <KeySerialNumber>KeySerialNumber</ KeySerialNumber > Used for managing DUKPT pin-pads for non-PIN-less debit
transactions <PNRef>PNRef</PNRef> Reference number assigned by the Payment Gateway.
This field is required for ALL transactions however a value may be left blank. <AuthCode>ApprovalCode</AuthCode> Optional unless TransType = Force. <PONum>PONumber</PONum> Customer
PO number. <TipAmt>TipAmount</TipAmt> Tip
amount in DDDD.CC format <TaxAmt>TaxAmount</TaxAmt> Tax
amount in DDDD.CC format <SequenceNum>SequenceNum</SequenceNum> 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 <SequenceCount>SequenceCount</SequenceCount> 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 <ServerID>ServerID</ServerID> Unique
server identification number. <TimeOut>TimeOut</TimeOut> Timeout
value in seconds (default = 40) <TrainingMode>TrainingMode</TrainingMode> Process
transaction in Training Mode; either T or F <Force>Force</Force> Forcing
duplicate transactions to be processed; either T or F. Note that some
processors will not utilize this tag and may still reject a duplicate
transaction <RegisterNum>RegisterNum</RegisterNum> Register
number. <City>City</City> The
city name of the cardholder's billing address. <BillToState>State</BillToState> The two
character state code of the cardholder's billing address. <CustomerID>CustomerID</CustomerID> Customer
ID for tracking purposes <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). <EntryMode>EntryModeValue</EntryMode> Indicates
how the values for the payment information were obtained. The Valid values
for this tag are: UNKNOWN, MANUAL,MAGNETICSTRIPE,ICC, and PROXIMITY <Invoice>Invoice</Invoice> Indicates
invoice details. See below for hierarchy of elements nested within. Please note
that all elements included inside <Invoice> must be in the specific
order listed below: --BEGIN INVOICE <Invoice> <InvNum>InvNum</InvNum>
Purchase
invoice number <Date>Date</Date>
Date of
invoice. --BEGIN BILLTO <BillTo> <CustomerId>CustomerId</CustomerId>
Customer
ID number <Name>Name</Name> Customer
name --BEGIN ADDRESS <Address> <Street>Street</Street>
Customer
street <City>City</City>
Customer
city <State>State</State>
Customer
state <Zip>Zip</Zip>
Customer
zip code <Country>Country</Country>
Customer
country </Address> --END 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> --END BILLTO <Description>Description</Description> Description
of purchase --BEGIN ITEMS <Items> Items
contained in invoice. Contains one or more <Item> elements One
item in invoice (item details nested within). There may be multiple
<Item> nested within <Items> tag <Description>Description</Description> Item
description <Quantity>Quantity</Quantity> Quantity
purchased of item <UnitOfMeasurement>UnitOfMeasure</UnitOfMeasurement> Unit of
measurement for item <UnitPrice>UnitPrice</UnitPrice> Unit
price of item <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> --END ITEM <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> --END INVOICE |
ProcessDebitCard
Examples
The example parameters and values below will process
a swiped debit card Sale transaction through the payment server.
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale |
|
CardNum |
4055011111111111 |
|
ExpDate |
1112 |
|
NameOnCard |
John Doe |
|
Amount |
1.00 |
|
ExtData |
<Timeout>100</Timeout><KeySerialNumber>4A003102930003BB</KeySerialNumber> |
|
PNRef |
|
|
InvNum |
1001 |
|
Pin |
6366C0466A74C3F6 |
|
MagData |
4055011111111111=05121015432112345678 |
|
CashBackAmt |
0.5 |
Response
Example:
<?xml version="1.0"
encoding="utf-8" ?>
<Response
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://secure.payleap.com/SmartPayments/">
<Result>0</Result>
<RespMSG>Approved</RespMSG>
<Message>APPROVAL</Message>
<AuthCode>2428</AuthCode>
<PNRef>2428</PNRef>
<ExtData>InvNum=1001,CardType=DEBIT</ExtData>
</Response>
The example parameters and values below will process
a swiped debit card Return transaction through the payment server. The PNRef parameter value should be to
the PNRef value generated during the original transaction in your test.
|
Parameter |
Value |
|
UserName |
PayLeap UserName |
|
Password |
PayLeap Password |
|
TransType |
Return |
|
CardNum |
4055011111111111 |
|
ExpDate |
1112 |
|
NameOnCard |
John Doe |
|
Amount |
1.00 |
|
ExtData |
<KeySerialNumber>4A003102930003BB</KeySerialNumber> |
|
PNRef |
2428 |
|
InvNum |
1001 |
|
Pin |
6366C0466A74C3F6 |
|
MagData |
4055011111111111=05121015432112345678 |
Response
Example:
<?xml
version="1.0" encoding="utf-8" ?>
<Response
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://secure.payleap.com/SmartPayments/">
<Result>0</Result>
<RespMSG>Approved</RespMSG>
<Message>APPROVAL</Message>
<AuthCode>2431</AuthCode>
<PNRef>2431</PNRef>
<ExtData>CardType=DEBIT</ExtData>
</Response>
ProcessEBTCard
|
ProcessEBTCard
URL |
|
|
Production Server |
https://secure.payleap.com/SmartPayments/transact.asmx/ProcessEBTCard |
|
Test Server |
http://test.payleap.com/SmartPayments/transact.asmx/ProcessEBTCard |
|
Parameter |
Value |
|
UserName |
PayLeap
UserName |
|
Password |
PayLeap Password |
|
TransType |
FoodStampSale Authorization and Capture of funds. CashBenefitsSale Authorization and Capture from card holders Cash Benefit account. FoodStampReturn Issue refund of funds. Transaction must be settled to perform a return. Inquire Check EBT balance. Force Force a previous Auth into the current batch. This will capture funds on an Authorization Only not in the current batch. The PNRef number generated during the original Auth is required for this to function correctly. Capture Capture funds of specific transaction in current batch. The PNRef number generated during the original Auth is required for this to function correctly. CaptureAll Capture All transactions in the current batch. |
|
CardNum |
Required unless
TransType = Capture,
CaptureAll. |
|
ExpDate |
Required unless
TransType = Capture,
CaptureAll. |
|
MagData |
Field Required.
Value optional unless processing a swiped credit card. 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. |
|
NameOnCard |
Optional, depending on different merchant processor
setups. The cardholder’s name as it appears on the card. |
|
Amount |
Required unless
TransType = CaptureAll. |
|
InvNum |
Optional. Invoice tracking number. |
|
Pin |
Required unless
TransType = Capture,
CaptureAll. |
|
RegisterNum
|
Optional.
A number that uniquely identifies a register or computer on which the
transaction was performed. |
|
ExtData |
Extended Data in XML format ExtData field is required for ALL transactions. Value may be left blank in most cases. <KeySerialNumber>KeySerialNumber</KeySerialNumber> Optional unless TransType = FoodStampSale, FoodStampReturn, CashBenefitSale, Inquire. <TimeOut>Seconds</TimeOut> Optional. Value in seconds before a transaction times out. Default = 40 seconds. <TrainingMode>TrainingMode</TrainingMode> Process transaction in Training Mode; either T or F <Force>Force</Force>
Forcing duplicate transactions to be processed; either T
or F. Note that some processors will not utilize this tag and may still
reject a duplicate transaction. |
ProcessEBTCard Examples
The example parameters and values below
will process a swiped EBT FoodStampSale.
|
Parameter |
Value |
|
UserName |
PayLeap
UserName |
|
Password |
PayLeap Password |
|
TransType |
Sale |
|
CardNum |
44055011111111111 |
|
ExpDate |
1112 |
|
MagData |
4055011111111111=05121015432112345678 |
|
NameOnCard |
John Doe |
|
Amount |
1.00 |
|
Pin |