One Solution. Higher Profits
SCM API Guide
Visit 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.
Thank you for choosing PayLeap, LLC!
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:
Email: [email protected]
Phone: 866-267-9609
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
© 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
SCM API Guide
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.
LIMITED WARRANTY. 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 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.
DISCLAIMER. EXCEPT AS EXPRESSLY SET FORTH, COMPANY SPECIFICALLY DISCLAIMS ALL
REPRESENTATIONS, WARRANTIES, AND CONDITIONS WHETHER EXPRESS OR IMPLIED,
© 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
SCM API Guide
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 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.
LIMITATION OF LIABILITY. PAYLEAP EXPRESSLY DISCLAIMS ANY LIABILITY OR LOSS
ARISING FROM OR RELATED TO THE SITE OR THE SERVICES (HOWEVER ARISING, INCLUDING
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.
EXCLUSION. 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.
© 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
SCM API Guide
Live Production Server
https://secure1.payleap.com/MerchantServices.svc
WSDL
https://secure1.payleap.com/MerchantServices.svc?WSDL
Test Server
https://uat.payleap.com/MerchantServices.svc
WSDL
https://secure1.payleap.com/MerchantServices.svc?WSDL
Testing can be performed with the following test cards:
Card Type
Number
MasterCard
5000300020003003
Visa
4005550000000019
Discover
60011111111111117
© 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
SCM API Guide
Diners
36999999999999
AMEX
374255312721002
Web Services

AddRecurringCreditCard -Allows customer information to be
programmatically stored through web services for recurring billing.

AddRecurringCheck- Allows check information to be programmatically
stored through web services for recurring billing.

ProcessCreditCard -Allows for processing credit card transactions in
recurring billing .

ProcessCheck- Allows for processing ACH /check transactions for
recurring billing.

ManageCheckInfo – Allows for programmatic management of existing
check information for recurring billing.

ManageCreditCardInfo- Allows for programmatic management of credit
card information for customers specific to recurring billing.

ManageContract – Allows for managing existing contracts for updates
and modifications.

ManageCustomer – Allows for management of existing customers in the
recurring billing web service.

ManageContractAddDaysToNextBillDt – Allows for modification of
next billing date for recurring billing contracts.
© 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
SCM API Guide
AddRecurringCreditCard
This web service operation allows you to add a customer, a contract and a credit
card payment method all in one call. All parameters marked as required must be
supplied. Optional parameters can be left blank and the default value will be
used. Default values are empty strings for string type and 0 for integer type.The
URL to access this web service is:
https://uat.payleap.com/MerchantServices.svc/AddRecurringCreditCard
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Vendor
CustomerID
Customer Name
Required. The numerical Vendor/Merchant Key.
Required. A merchant supplied a unique identifier for a
customer.
Required. The customer’s name is to be submitted in this
field.
FirstName
Optional. The customer’s first name.
LastName
Optional. The customer’s last name.
Title
Department
Street1
Optional. The customer’s title.
Optional. The customer’ department.
Optional. The customer’s street address 1.
© 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
SCM API Guide
Street2
Optional. The customer’s street address 2.
Street3
Optional. The customer’s street adddress3.
City
Optional. The customer’s city.
StateID
Optional. The customer’s 2 character State Code
Province
Optional. The customer’s province if it is outside the
USA
Zip
Optional. The customer’s zip code if in the USA, postal
code if outside the USA
CountryID
Optional. The customer’s 3 character country code, for
example, USA or CAN
Email
Optional. The customer’s email address.
Mobile
Optional. The customer’s mobile phone.
ContractID
ContractName
Required. The merchant supplied unique indentifier for
the contract.
Optional. The contract’s name.
BillAmt
Required. The amount to be billed in relation to the
contract.
TaxAmt
Optional. The tax amount.
© 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
SCM API Guide
TotalAmt
Required. This is the total amount. BillAmt + TaxAmt =
TotalAmt.
StartDate
Required. The start date of the contract.
EndDate
Optional. The end date of the contract. If this date is not
given, the contract will continue to run until manually
cancelled or suspended by the system due to failure of
payment
BillingPeriod
Required. Specifies the Billing Period Type, used in
conjunction with BillingInterval to compute the next bill
date.
Required. Depending on the billing period, it can mean
different things such as DAY = every X number of days,
BillingInterval
WEEK = number of times per week,
MONTH = number fo times per month;
YEAR = number of times per year.
MaxFailures
Optional. The number of times the system will wait after
each retry when a recurring payment fails to process
before it puts the contract in suspended mode.
FailureInterval
Optional. Number of days the system will wait after each
payment retry when the payment fails.
EmailCustomer
Optional. TRUE/FALSE setting whether to email the
© 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
SCM API Guide
customer regarding the status of the recurring payment.
EmailMerchant
Optional. TRUE/FALSE setting whether to email the
merchant regarding the status of recurring payment.
EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the
customer when the recurring payment fails.
EmailMerchantFailure Optional. TRUE/FALSE setting whether to email the
merchant when the recurring payment fails.
CcAccountNum
CcExpdate
CcNameOnCard
CcStreet
CcZip
Required. The customer’s credit card number.
Required. The credit card expiration date.
Optional. The Card Holder’s name as it is on the card.
Optional. The Card Holder’s billing address
Optional. The Card Holder’s billing zip code.
Optional. Extended Data.
ExtData
© 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
SCM API Guide
© 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
SCM API Guide
© 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
SCM API Guide
Response
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>11</CustomerKey>
<ContractKey>7</ContractKey>
<CcInfoKey>26607</CcInfoKey>
<CheckInfoKey />
© 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
SCM API Guide
<code>OK</code>
<error>OK</error>
<Partner>100</Partner>
<Vendor>1</Vendor>
<Username>vital</Username>
</RecurringResult>
AddRecurringCheck
This web service allows for adding a customer, a contract and a credit card
payment method all in one call.All parameters marked as required must be
supplied. Optional parameters can be left blank and the default value will be
used. Default values are as follows, empty string for string type and 0 for integer.
The URL to access this web service is:
https://uat.payleap.com/MerchantServices.svc/AddRecurringCheck
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Vendor
Required. The numerical Vendor/Merchant Key.
© 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
SCM API Guide
CustomerID
Required. A merchant supplied a unique indentifier
for a customer.
Customer Name
Required. The customer’s name is to be submitted in
this field.
FirstName
Optional. The customer’s first name.
LastName
Optional. The customer’s last name.
Title
Department
Optional. The customer’s title.
Optional. The customer’ department.
Street1
Optional. The customer’s street address 1.
Street2
Optional. The customer’s street address 2.
Street3
Optional. The customer’s street adddress3.
City
Optional. The customer’s city.
StateID
Optional. The customer’s 2 character State Code
Province
Optional. The customer’s province if it is outside the
USA
Zip
CountryID
Optional. The customer’s zip code if in the USA,
postal code if outside the USA
Optional. The customer’s 3 character country code,
for example, USA or CAN
© 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
SCM API Guide
Email
Optional. The customer’s email address.
Mobile
Optional. The customer’s mobile phone.
ContractID
ContractName
Required. The merchant supplied unique indentifier
for the contract.
Optional. The contract’s name.
BillAmt
Optional. The amount to be billed in relation to the
contract.
TaxAmt
Optional. The tax amount.
TotalAmt
Required. This is the total amount. BillAmt +
TaxAmt = TotalAmt.
StartDate
Required. The start date of the contract.
EndDate
Optional. The end date of the contract. If this date is
not given, the contract will continue to run until
manually cancelled or suspended by the system due
to failure of payment
BillingPeriod
Required. Specifies the Billing Period Type, used in
conjunction with BillingInterval to compute the next
bill date.
BillingInterval
Required. Depending on the billing period, it can
mean different things such as DAY = every X
© 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
SCM API Guide
number of days,
WEEK = number of times per week,
MONTH = number fo times per month;
YEAR = number of times per year.
MaxFailures
Optional. The number of times the system will wait
after each retry when a recurring payment fails to
process before it puts the contract in suspended mode.
FailureInterval
Optional. Number of days the system will wait after
each payment retry when the payment fails.
EmailCustomer
Optional. TRUE/FALSE setting whether to email the
customer regarding the status of the recurring
payment.
EmailMerchant
Optional. TRUE/FALSE setting whether to email the
merchant regarding the status of recurring payment.
EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the
customer when the recurring payment fails.
EmailMerchantFailure Optional. TRUE/FALSE setting whether to email the
merchant when the recurring payemt fails.
CheckType
AccountType
Required. Two types of checks whether PERSONAL
or BUSINESS.
Required. Two types of account whether
© 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
SCM API Guide
CHECKING or SAVINGS.
CheckNum
MICR
Optional. This is the check number.
Optional. This is the scanned MICR data of the
check.
AccountNum
Required. This is the account number.
TransitNum
Required. This is the transit number.
SS
DOB
Optional. Social Security number of the check holder.
Optional. Date of Birth of the check holder.
BranchCity
Optional. The city of the bank where the branch is
located.
DL
Optional. The driver’s license number of the check
holder
StateCode
Optional. The 2 character State Code of the driver’s
License of the check holder.
NameOnCheck
ExtData
Optional. The check holder’s name as it is on the
check.
R Optional. Extended Data.
© 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
SCM API Guide
© 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
SCM API Guide
Example
© 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
SCM API Guide
© 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
SCM API Guide
© 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
SCM API Guide
Response
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>12</CustomerKey>
<ContractKey>8</ContractKey>
<CcInfoKey />
<CheckInfoKey>3</CheckInfoKey>
<code>OK</code>
© 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
SCM API Guide
<error>OK</error>
<Partner>100</Partner>
<Vendor>41</Vendor>
<Username>ncn1</Username>
</RecurringResult>
ProcessCreditCard - Recurrring Billing
This web service operation processes credit card transactions within the recurring
billing module. The URL to access this web service is:
https://uat.payleap.com/MerchantServices.svc/ProcessCreditCard
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Vendor
CcInfoKey
Required. The numerical Vendor/Merchant Key.
Required. The numerical Credit Card Info key.
Amount
Required. The amount that will be processed for that
transaction.
InvNum
Optional. The associated invoice number.
© 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
SCM API Guide
ExtData
Optional. Extended Data.
Example
Response:
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<code>OK</code>
© 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
SCM API Guide
<error>APPROVED</error>
<Result>0</Result>
<AuthCode>TAS351</AuthCode>
<PNRef>26873</PNRef>
<Message>NO MATCH</Message>
</RecurringResult>
ProcessCheck – Recurring Billing
This web service operation allows for the processing of check transactions within
the recurring billing module. The URL to access this Web Service is:
https://uat.payleap.com/MerchantServices.svc/ProcessCheck
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Vendor
CheckInfoKey
Amount
Required. The numerical Vendor/Merchant Key.
Required. The numerical Check Payment Info key.
Required. The amount that will be processed for that
transaction.
© 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
SCM API Guide
InvNum
Optional. The associated invoice number.
ExtData
Optional. Extended Data.
Example
Response
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-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.
26
One Solution. Higher Profits
SCM API Guide
<code>OK</code>
<error>APPROVED</error>
<Result>0</Result>
<AuthCode>AUTH NUM 674-564</AuthCode>
<PNRef>26945</PNRef>
<Message>APPROVAL</Message>
</RecurringResult>
ManageCheckInfo
This Web Service operation allows for managing check information .The URL to
access this Web Service is:
https://uat.payleap.com/MerchantServices.svc/ManageCheckInfo
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Vendor
Required. The numerical Vendor/Merchant Key.
CustomerKey
Required. The numerical customer key.
CheckInfoKey
Required for TransType UPDATE and DELETE. The
numerical Customer Key
© 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
SCM API Guide
CheckType
Required. Two types of checks whether PERSONAL or
BUSINESS.
AccountType
Required. Two types of account whether CHECKING or
SAVINGS.
CheckNum
MICR
Optional. This is the check number.
Optional. This is the scanned MICR data of the check.
AccountNum
Required. This is the account number.
TransitNum
Required. This is the transit number.
SS
DOB
Optional. Social Security number of the check holder.
Optional. Date of Birth of the check holder.
BranchCity
Optional. The city of the bank where the branch is located.
DL
Optional. The driver’s license number of the check holder
StateCode
NameOnCheck
Email
DayPhone
Optiional. The 2 character State Code of the driver’s
license of the check holder, e.g. NY or GA
Optional. The check holder’s name as it is on the check.
Optional. The customer’s email address.
Optional. The customer’s day phone.
Street1
Optional. The customer’s street address 1.
Street2
Optional. The customer’s street address 2.
© 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
SCM API Guide
Street3
City
Optional. The customer’s street adddress3.
Optional. The customer’s city.
StateID
Optional. The customer’s 2 character State Code
Province
Optional. The customer’s province if it is outside the USA
PostalCode
Optional. The customer’s zip code if in USA , postal code
if outside USA
CountryID
Optional. The customer’s 3 character country code, for
example, USA or CAN
ExtData
R Optional. Extended Data.
© 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
SCM API Guide
Example
© 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
SCM API Guide
© 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
SCM API Guide
Response
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>12</CustomerKey>
<ContractKey />
<CcInfoKey />
<CheckInfoKey>4</CheckInfoKey>
<code>OK</code>
<error>OK</error>
<Partner>100</Partner>
<Vendor>41</Vendor>
<Username>ncn1</Username>
</RecurringResult>
© 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
SCM API Guide
ManageCreditCardInfo
This Web Service allows for managing the credit card information. The URL for
accessing this Web Service is at:
https://uat.payleap.com/MerchantServices.svc/ManageCreditCardInfo
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Required. The type of transaction being performed. Valid
values are:
TransType
ADD
UPDATE
DELETE
Vendor
Required. The numerical Vendor/Merchant Key.
CustomerKey
Required. The numerical Customer Key.
CardInfoKey
Required. The numerical credit card info key.
CcAccountNum
Required. The credit card account number.
CcExpDate
Required. The credit card expiration date.
CcNameonCard
CcStreet
Optional. The name of the card holder
Optional. The card holder’s billing address.
© 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
SCM API Guide
CcZip
ExtData
Optional. The card holder’s billing zip code.
Optional. Extended Data.
© 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
SCM API Guide
Example
Response
© 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
SCM API Guide
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>11</CustomerKey>
<ContractKey />
<CcInfoKey>26674</CcInfoKey>
<CheckInfoKey />
<code>OK</code>
<error>OK</error>
<Partner>100</Partner>
<Vendor>1</Vendor>
<Username>vital</Username>
</RecurringResult>
© 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
SCM API Guide
ManageContract
This web service allows for managing different properties of contracts via
integration. This can be accessed by using this URL:
https://uat.payleap.com/MerchantServices.svc/ManageContract
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Required. The type of transaction being performed. The
valid values are:
TransType
ADD
UPDATE
DELETE
Vendor
Required. The numerical Vendor/Merchant Key.
CustomerKey
Required. The numerical customer key.
ContractKey
Required for TransType UPDATE and DELETE. The
numerical contract key.
PaymentInfoKey
Required for Transtype UPDATE and ADD. The
numerical information Key. This is dependent for the
PaymentType. If you set the Payment Type to CC then
the information that needs to be passed in this field is the
CCInfoKey or CardInfoKey. Now if CK was set at the
PaymentType, then the information that needs to go in
© 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
SCM API Guide
this field is the CheckInfoKey. Please make sure that
you are passing the right key based on the PaymentType.
PaymentType
Required for TransType ADD and UPDATE. Type of
payment:
CC for Credit Card and CK for Check
CustomerID
Required. A merchant supplied a unique indentifier for a
customer.
Customer Name
Required. The customer’s name is to be submitted in this
field.
FirstName
Optional. The customer’s first name.
LastName
Optional. The customer’s last name.
Title
Department
Optional. The customer’s title.
Optional. The customer’ department.
Street1
Optional. The customer’s street address 1.
Street2
Optional. The customer’s street address 2.
Street3
Optional. The customer’s street adddress3.
City
Optional. The customer’s city.
StateID
Optional. The customer’s 2 character State Code
Province
Optional. The customer’s province if it is outside the
USA
© 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
SCM API Guide
Zip
Optional. The customer’s zip code if in the USA, postal
code if outside the USA
CountryID
Optional. The customer’s 3 character country code, for
example, USA or CAN
DayPhone
Optional. The customer’s day phone.
NightPhone
Fax
Optional.The customer’s evening phone.
Optional. The customer’s fax number.
Email
Optional. The customer’s email address.
Mobile
Optional. The customer’s mobile phone.
ContractID
ContractName
Required. The merchant supplied unique indentifier for
the contract.
Optional. The contract’s name.
BillAmt
Optional. The amount to be billed in relation to the
contract.
TaxAmt
Optional. The tax amount.
TotalAmt
Required. This is the total amount. BillAmt + TaxAmt =
TotalAmt.
StartDate
Required. The start date of the contract.
© 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
SCM API Guide
EndDate
Optional. The end date of the contract. If this date is not
given, the contract will continue to run until manually
cancelled or suspended by the system due to failure of
payment
NextBillDt
Required. This is required for TRANSTYPE ADD and
UPDATE.
BillingPeriod
Required. Specifies the Billing Period Type, used in
conjunction with BillingInterval to compute the next bill
date.
Required. Depending on the billing period, it can mean
different things such as DAY = every X number of days,
BillingInterval
WEEK = number of times per week,
MONTH = number fo times per month;
YEAR = number of times per year.
MaxFailures
Optional. The number of times the system will wait after
each retry when a recurring payment fails to process
before it puts the contract in suspended mode.
FailureInterval
Optional. Number of days the system will wait after each
payment retry when the payment fails.
EmailCustomer
Optional. TRUE/FALSE setting whether to email the
customer regarding the status of the recurring payment.
© 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
SCM API Guide
EmailMerchant
Optional. TRUE/FALSE setting whether to email the
merchant regarding the status of recurring payment.
EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the
customer when the recurring payment fails.
EmailMerchantFailure Optional. TRUE/FALSE setting whether to email the
merchant when the recurring payemt fails.
Status
ExtData
Optional. Status of the contract.
R Optional. Extended Data.
Example
© 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
SCM API Guide
© 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
SCM API Guide
© 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
SCM API Guide
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>11</CustomerKey>
© 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
SCM API Guide
<ContractKey>7</ContractKey>
<CcInfoKey>26607</CcInfoKey>
<CheckInfoKey />
<code>OK</code>
<error>OK</error>
<Partner>100</Partner>
<Vendor>1</Vendor>
<Username>vital</Username>
</RecurringResult>
ManageCustomer
This web service allows for the management of customer information. This web
service can be accessed by this url:
http://savqaps/admin/ws/recurring.asmx?op=ManageCustomer
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
TransType
Required. The type of transaction being performed. The
valid values are:
© 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
SCM API Guide
ADD
UPDATE
DELETE
Vendor
CustomerKey
Required. The numerical Vendor/Merchant Key.
Required. The numerical customer key.
CustomerID
Required. A merchant supplied a unique indentifier for a
customer.
Customer Name
Required. The customer’s name is to be submitted in this
field.
FirstName
Optional. The customer’s first name.
LastName
Optional. The customer’s last name.
Title
Department
Optional. The customer’s title.
Optional. The customer’ department.
Street1
Optional. The customer’s street address 1.
Street2
Optional. The customer’s street address 2.
Street3
Optional. The customer’s street adddress3.
City
StateID
Optional. The customer’s city.
Optional. The customer’s 2 character State Code
© 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
SCM API Guide
Province
Optional. The customer’s province if it is outside the USA
Zip
Optional. The customer’s zip code if in the USA, postal
code if outside the USA
CountryID
Optional. The customer’s 3 character country code, for
example, USA or CAN
DayPhone
Optional. The customer’s day phone.
NightPhone
Fax
Optional.The customer’s evening phone.
Optional. The customer’s fax number.
Email
Optional. The customer’s email address.
Mobile
Optional. The customer’s mobile phone.
Status
Optional. Status of the contract.
ExtData
R Optional. Extended Data.
© 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
SCM API Guide
© 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
SCM API Guide
Response
<?xml version="1.0" encoding="utf-8" ?>
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>11</CustomerKey>
© 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
SCM API Guide
<code>OK</code>
<error>OK</error>
<Partner />
<Vendor>1</Vendor>
<Username>vital</Username>
</RecurringResult>
ManageContractAddDaysToNextBillDt
This web service allows for adding days to the next billing date and it can be
accessed by this URL:
https://uat.payleap.com/MerchantServices.svc/ManageContractAddDaysToNext
BillDt
Parameter
Value
Username
Required. The username of the admin user.
Password
Required. The password of the admin user
Vendor
Required. The numerical Vendor/Merchant Key.
© 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
SCM API Guide
CustomerKey
Required. The numerical customer key.
ContractKey
Required for TransType UPDATE and DELETE. The
numerical contract key.
NumOfDays
The number of days to be added.
ExtData
Optional. Extended Data.
Example
Response
<?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.
51
One Solution. Higher Profits
SCM API Guide
- <RecurringResult xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.payleap.com/payments">
<CustomerKey>11</CustomerKey>
<ContractKey>7</ContractKey>
<CcInfoKey />
<CheckInfoKey />
<code>OK</code>
<error>NextBillDate=2/28/2007</error>
<Partner />
<Vendor />
<Username>vital</Username>
</RecurringResult>
BIN Management Network Table Values
Debit Network
Accel
Network ID
ACL
Network Authorization Number
69
© 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
SCM API Guide
AFFN
AFN
68
Alaska Option
AKO
61
CU24
C24
85
Interlink
ILK
48
Jeanie
JEN
86
Star Northeast (MAC)
MAC
17
Maestro
MAE
40
Nets
NET
83
NYCE
NYC
28
Pulse
PUL
06
Star Southeast
SES
07
Shazam
SHZ
58
Star West
STX
23
TYME
TYM
78
Web Service Response Field
Transact.asmx
Response Field
Data Type
Value Description
Remarks
© 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
SCM API Guide
AuthCode
Returns the transaction
result code from the
A string value payment processor
up to 50
characters
Returns extra data from the
processed transaction
ExtData
A string value
up to 500
characters
This value can be
either an approval
code, for approved
transactions, or an
error code, for
declined
transactions
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
with a comma. See
the “Web Service
ExtData Response
Field Data
Elements” for full
description of data
elements that can
be returned. The
following is an
example of the
format:
ExtName1=ExtVal
ue1,ExtName2=Ext
Value2
© 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
SCM API Guide
GetAVSResult
GetAVS
ResultTXT
Returns the overall address When
verification result code from programmatically
the payment processor
validating an AVS
Result, this value
A string value
should ALWAYS
up to 1
be used instead of
character
any formatted
response message
describing the
result
Returns the formatted
response message when
address verification is
A string value
performed
up to 25
characters
Returns the payment
processor's response
indicator that specifies if the
card is a commercial card
Get
CommercialCard
A string value
representing a
Boolean value
Do NOT use this
when
programmatically
validating a
transaction’s AVS
result; please 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 and not
embossed on the
front. It is used as
an extra
authentication
method for "card
© 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
SCM API Guide
not present"
transactions. When
programmatically
validating a CV
Result, this value
should ALWAYS
be used instead of
any formatted
response message
describing the
result
GetCVResult
Returns the card verification This value is only
result code from the
applicable to credit
payment processor
card transactions.
The card
verification
number is typically
printed on the back
of the card and not
embossed on the
A string value
front. It is used as
up to 1
an extra
character
authentication
method for "card
not present"
transactions. When
programmatically
validating a CV
Result, this value
should ALWAYS
be used instead of
any formatted
© 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
SCM API Guide
response message
describing the
result
GetCVResultTXT
Returns the formatted
This value is only
response message when card applicable to credit
verification is performed
card transactions.
Do NOT use this
A string value
when
up to 25
programmatically
characters
validating a
transaction’s CV
result; please see
GetCVResult field
Returns the formatted
response message when
street number address
A string value
verification is performed
GetStreetMatchTX
up to 25
T
characters
GetZipMatchTXT
HostCode
This value will
typically be
“Match”, for
correctly matching
the street address,
or “No Match”, for
an incorrect street
address
Returns the formatted
response message when zip
A string value code address verification is
up to 25
performed
characters
This value will
typically be
“Match”, for
correctly matching
the zip code, or
“No Match”, for an
incorrect zip code
A string value Typically returns a number
up to 30
which uniquely identifies
This value may not
be returned for all
© 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
SCM API Guide
characters
Message
Message1
Message2
the transaction in the
payment processor
payment
processors
Returns a formatted
response message
concerning the processed
transaction
This value will
typically be
“APPROVAL”,
for approved
transactions, or an
error message, for
declined
transactions. Do
NOT use this when
programmatically
validating a
transaction’s
result; please see
Result field below
A string value
up to 50
characters
Returns an extra formatted
response message giving
more information about the
A string value
processed transaction
up to 50
characters
The Payment
Server will only
populate this field
when there is
applicable
information from
the payment
processor to return
Returns an extra formatted
response message giving
A string value
more information about the
up to 50
processed transaction
characters
The Payment
Server will only
populate this field
when there is
applicable
information from
© 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
SCM API Guide
the payment
processor to return
PNRef
A string value
representing a
signed 32-bit
integer
Returns a number which
uniquely identifies the
transaction in the payment
gateway
Returns the response
message concerning the
processed transaction
RespMSG
Result
A string value
up to 50
characters
Returns the transaction
result code from the
payment gateway which
signifies the result of the
transaction (i.e. approved,
A string value decline, etc.)
representing a
signed 32-bit
integer
This value is
typically either
Approved or
Declined. Do
NOT use this when
programmatically
validating a
transaction’s
result; please see
Result field below
When
programmatically
validating a
transaction’s
result, this value
should ALWAYS
be used instead of
any response
message describing
the result. See the
“Result Response
Fields Definitions”
section for a full
list of result values
© 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
SCM API Guide
and descriptions
Transact.asmx Web Service ExtData Response Field Data Elements
Data Element Name
Value Description
Remarks
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
BatchNum
TrxDetail.asmx
Response Field
Account_Type_CH
Data Type
Value Description
A string
Returns the card
Remarks
© 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
SCM API Guide
value up to
10 characters
AccountNum_VC
Acct_Num_CH
Amount_MN
Approval_Code_CH
type of the
transaction, e.g.
VISA, Diners, EBT
Returns the check
account number
This field will be
masked out with
asterisk (*)
characters except
for the last 4
digits if the
System Security
Level of the user
is set to 1
Returns credit card
number
This field will be
masked out with
asterisk (*)
characters except
for the last 4
digits if the
System Security
Level of the user
is set to 1
A string
value up to
200
characters
A string
value up to
200
characters
A string
Returns the check’s
value
total amount
representing a
signed 64-bit
real number
A string
value up to
50 characters
Returns the
response code from
the payment
processor
© 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
SCM API Guide
Auth_Amt_MN
A string
Returns the
value
authorized amount
representing a of a card transaction
signed 64-bit
real number
Authorization
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
Authorization
(PreAuth)
transactions
Authorization_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all Authorization
(PreAuth)
transactions
AVS_Resp_CH
A string
value up to 1
character
Returns the address
verification result
code from the
payment processor
A string
value up to
25 characters
Returns the
formatted response
message when
address verification
is performed
A string
value up to
10 characters
Returns the batch
number for the
transaction that was
returned by the
payment processor
AVS_Resp_Txt_VC
Batch_Number
Not all payment
processors
support returning
this data element
© 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
SCM API Guide
Capture
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
Capture
transactions
Capture_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
This value will
transaction count of always return
all Capture
“0”
transactions
Card_Info_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
CC_Info_T table in
the database
A string
value
Cash_Back_Amt_MN representing a
signed 64-bit
real number
CheckNum_CH
Cnt
A string
value up to
10 characters
This value will
always return
“0”
Returns the cash
back amount for a
debit or EBT
transaction
Returns the check
number
A string
Returns the
value
transaction count of
representing a all transactions
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.
63
One Solution. Higher Profits
SCM API Guide
CustomerID
A string
value up to
50 characters
Returns the
Customer ID of a
customer to which
the transaction
belongs to
CV_Resp_CH
A string
value up to 1
character
Returns the card
verification result
code from the
payment processor
CV_Resp_Txt_VC
A string
value up to
25 characters
Returns the
formatted response
message when card
verification is
performed
Date_DT
A string
value
representing a
date and time
Returns the date on
which the
transaction is first
made
ERROR
A string
value up to
200
characters
Returns an error
message when a
problem occurs
during the
transaction
processing
Exp_CH
A string
value up to
10 characters
Returns the credit
card expiration date
A string
Returns the dollar
ForceCapture
© 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
SCM API Guide
value
representing a
signed 64-bit
real number
amount of all
ForceCapture
(ForceAuth)
transactions
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all ForceCapture
(ForceAuth)
transactions
Host_Date_CH
A string
value up to
10 characters
Returns the
payment
processor’s date on
which the
transaction is
performed
Host_Ref_Num_CH
A string
value up to
30 characters
Returns a number
which uniquely
identifies the
transaction for the
payment processor
A string
value up to
10 characters
Returns the
payment
processor’s time at
which the
transaction was
performed
A string
value up to
100
Returns the
transaction’s
Invoice number
ForceCapture_Cnt
Host_Time_CH
Invoice_ID
© 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
SCM API Guide
characters
IP_VC
A string
value up to
15 characters
Returns the IP
address of the client
machine from
which the
transaction was
processed
Last_Update_DT
A string
value
representing a
date and time
Returns the date
and time on which
the transaction is
last modified
Manual
A string
Returns the card
value
was swiped or not
representing a
Boolean
value
Merchant_Key
A string
value
representing a
signed 32-bit
integer
Returns a number
which uniquely
identifies a
merchant
Name_on_Card_VC
A string
value up to
25 characters
Returns the name of
the cardholder
NameOnCheck_VC
A string
value up to
25 characters
Returns the check
payer’s name on the
check
Orig_TRX_HD_Key
A string
Returns the
© 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
SCM API Guide
value
TRX_HD_Key on
representing a which the current
signed 32-bit transaction is based
integer
Payment_Type_ID
A string
value up to
10 characters
Returns the
payment type, e.g.
ECHECK
PostAuth
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
PostAuth
transactions
PostAuth_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all PostAuth
transactions
Processor_ID
A string
value up to
10 characters
Returns the name
the payment
processor, e.g. Vital
Receipt
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
transactions with a
Receipt
Receipt_Cnt
This value will
always return
“0”
A string
Returns the
This value will
value
transaction count of always return
representing a all transactions with “0”
© 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
SCM API Guide
signed 32-bit
integer
a Receipt
Not currently used
Ref_Number_CH
A string
A string
Register_Number_CH value up to
10 characters
Returns the register
number of a
transaction
RepeatSale
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
RepeatSale
(Recurring
Billing/Installment)
transactions
RepeatSale_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all RepeatSale
(Recurring
Billing/Installment)
transactions
A string
Returns the primary
Reseller_Key
This field is not
the unique
transaction
identifier (also
called PNRef) of
the Payment
Server. See the
field
TRX_HD_Key
for the PNRef
value
© 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
SCM API Guide
value
key of the
representing a Reseller_T table in
signed 32-bit the database
integer
Result_CH
A string
value up to
50 characters
Returns the
transaction
processing result,
e.g. 0, 12. “0” for
approval, “12” for
decline
Result_Msg_VC
A string
value up to
50 characters
Returns the check
transaction’s
processing result
A string
value up to
50 characters
Returns an extra
formatted response
message giving
more information
about the processed
transaction
A string
value up to
50 characters
Returns an extra
formatted response
message giving
more information
about the processed
transaction
A string
value up to
150
characters
Returns the text
message of either
approval or decline
for the transaction
Result_Msg1_VC
Result_Msg2_VC
Result_Txt_VC
© 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
SCM API Guide
processing result
Return
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
Return (Credit)
transactions
Return_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all Return (Credit)
transactions
Sale
Sale_Cnt
A string
Returns the dollar
value
amount of all Sale
representing a transactions
signed 64-bit
real number
A string
Returns the
value
transaction count of
representing a all Sale transactions
signed 32-bit
integer
Settle_Date_DT
A string
value
representing a
date and time
Returns the date on
which the
transaction is
settled
Settle_Flag_CH
A string
Returns if the
value
transaction is
representing a settled or not
© 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
SCM API Guide
Boolean
value
StateCode_CH
A string
value up to
10 characters
Returns the state
code
Street_CH
A string
value up to
25 characters
Returns the billing
street address of the
credit card
A string
Returns the sure
value
charge amount of a
SureCharge_Amt_MN representing a transaction
signed 64-bit
real number
Tip_Amt_MN
Trans_Type_ID
Transport_Method
Transport_EndPoint
A string
Returns the tip
value
amount of a
representing a transaction
signed 64-bit
real number
A string
value up to
20 characters
Returns the
transaction type,
e.g. Sale, Credit
A string
Returns the
Transportation
Method
Only for use
with Dial-up
transactions
A string
Returns the
Transportation’s
Ending Destination
Only for use
with Dial-up
transactions
© 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
SCM API Guide
Returns the
transit/routing
number
TransitNum_VC
A string
value up to
200
characters
TRX_Card_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
TRX_Card_T table
in the database
TRX_Check_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
TRX_Check_T
table in the database
TRX_HD_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
TRX_Header_T
table in the database
This field will be
masked out with
asterisk (*)
characters except
for the last 4
digits if the
System Security
Level of the user
is set to 1
This field is the
unique
transaction
identifier (also
called PNRef) of
the Payment
Server. Use its
value when
submitting
transactions
based on a
© 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
SCM API Guide
previous
transaction (i.e.
Voids) through
the
Transact.asmx
Web Service
TRX_Settle_Key
A string
value
representing a
signed 32-bit
integer
A string
TRX_Settle_Msg_VC value up to
25 characters
Returns the primary
key of the
TRX_Settle_T table
in the database
Returns the
transaction’s
settlement message
Type_CH
A string
value up to
10 characters
Returns the credit
card type, e.g.
VISA,
MASTERCARD
User_Name_VC
A string
value up to
25 characters
Returns the
username, under
which the
transactions were
made
Void_Flag_CH
A string
Returns the
value
transaction is
representing a voided or not
Boolean
value
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
73
One Solution. Higher Profits
SCM API Guide
Zip_CH
Auth_Amt_MN
A string
value up to
10 characters
Returns the billing
zip code of the
credit card
A string
Returns the
value
authorized amount
representing a of a card transaction
signed 64-bit
real number
Authorization
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
Authorization
(PreAuth)
transactions
Authorization_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all Authorization
(PreAuth)
transactions
AVS_Resp_CH
A string
value up to 1
character
Returns the address
verification result
code from the
payment processor
AVS_Resp_Txt_VC
A string
value up to
25 characters
Returns the
formatted response
message when
address verification
is performed
A string
Returns the batch
Batch_Number
Not all payment
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
74
One Solution. Higher Profits
SCM API Guide
value up to
10 characters
number for the
processors
transaction that was support returning
returned by the
this data element
payment processor
Capture
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
Capture
transactions
Capture_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
This value will
transaction count of always return
all Capture
“0”
transactions
Card_Info_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
CC_Info_T table in
the database
A string
value
Cash_Back_Amt_MN representing a
signed 64-bit
real number
CheckNum_CH
Cnt
This value will
always return
“0”
Returns the cash
back amount for a
debit or EBT
transaction
A string
value up to
10 characters
Returns the check
number
A string
Returns the
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
75
One Solution. Higher Profits
SCM API Guide
value
transaction count of
representing a all transactions
signed 32-bit
integer
CustomerID
A string
value up to
50 characters
Returns the
Customer ID of a
customer to which
the transaction
belongs to
CV_Resp_CH
A string
value up to 1
character
Returns the card
verification result
code from the
payment processor
CV_Resp_Txt_VC
A string
value up to
25 characters
Returns the
formatted response
message when card
verification is
performed
Date_DT
A string
value
representing a
date and time
Returns the date on
which the
transaction is first
made
ERROR
A string
value up to
200
characters
Returns an error
message when a
problem occurs
during the
transaction
processing
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
76
One Solution. Higher Profits
SCM API Guide
Exp_CH
A string
value up to
10 characters
Returns the credit
card expiration date
ForceCapture
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
ForceCapture
(ForceAuth)
transactions
ForceCapture_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all ForceCapture
(ForceAuth)
transactions
A string
value up to
10 characters
Returns the
payment
processor’s date on
which the
transaction is
performed
A string
value up to
30 characters
Returns a number
which uniquely
identifies the
transaction for the
payment processor
A string
value up to
10 characters
Returns the
payment
processor’s time at
which the
transaction was
Host_Date_CH
Host_Ref_Num_CH
Host_Time_CH
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
77
One Solution. Higher Profits
SCM API Guide
performed
Invoice_ID
A string
value up to
100
characters
Returns the
transaction’s
Invoice number
IP_VC
A string
value up to
15 characters
Returns the IP
address of the client
machine from
which the
transaction was
processed
Last_Update_DT
A string
value
representing a
date and time
Returns the date
and time on which
the transaction is
last modified
Manual
A string
Returns the card
value
was swiped or not
representing a
Boolean
value
Merchant_Key
A string
value
representing a
signed 32-bit
integer
Returns a number
which uniquely
identifies a
merchant
Name_on_Card_VC
A string
value up to
25 characters
Returns the name of
the cardholder
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
78
One Solution. Higher Profits
SCM API Guide
NameOnCheck_VC
A string
value up to
25 characters
Returns the check
payer’s name on the
check
Orig_TRX_HD_Key
A string
value
representing a
signed 32-bit
integer
Returns the
TRX_HD_Key on
which the current
transaction is based
Payment_Type_ID
A string
value up to
10 characters
Returns the
payment type, e.g.
ECHECK
PostAuth
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
PostAuth
transactions
PostAuth_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all PostAuth
transactions
Processor_ID
A string
value up to
10 characters
Returns the name
the payment
processor, e.g. Vital
Receipt
A string
value
representing a
signed 64-bit
Returns the dollar
amount of all
transactions with a
Receipt
This value will
always return
“0”
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
79
One Solution. Higher Profits
SCM API Guide
real number
Receipt_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
This value will
transaction count of always return
all transactions with “0”
a Receipt
Not currently used
Ref_Number_CH
A string
A string
Register_Number_CH value up to
10 characters
RepeatSale
RepeatSale_Cnt
A string
value
representing a
signed 64-bit
real number
This field is not
the unique
transaction
identifier (also
called PNRef) of
the Payment
Server. See the
field
TRX_HD_Key
for the PNRef
value
Returns the register
number of a
transaction
Returns the dollar
amount of all
RepeatSale
(Recurring
Billing/Installment)
transactions
A string
Returns the
value
transaction count of
representing a all RepeatSale
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
80
One Solution. Higher Profits
SCM API Guide
Reseller_Key
signed 32-bit
integer
(Recurring
Billing/Installment)
transactions
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
Reseller_T table in
the database
Result_CH
A string
value up to
50 characters
Returns the
transaction
processing result,
e.g. 0, 12. “0” for
approval, “12” for
decline
Result_Msg_VC
A string
value up to
50 characters
Returns the check
transaction’s
processing result
A string
value up to
50 characters
Returns an extra
formatted response
message giving
more information
about the processed
transaction
A string
value up to
50 characters
Returns an extra
formatted response
message giving
more information
about the processed
transaction
Result_Msg1_VC
Result_Msg2_VC
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
81
One Solution. Higher Profits
SCM API Guide
Result_Txt_VC
A string
value up to
150
characters
Returns the text
message of either
approval or decline
for the transaction
processing result
Return
A string
value
representing a
signed 64-bit
real number
Returns the dollar
amount of all
Return (Credit)
transactions
Return_Cnt
A string
value
representing a
signed 32-bit
integer
Returns the
transaction count of
all Return (Credit)
transactions
Sale
Sale_Cnt
Settle_Date_DT
A string
Returns the dollar
value
amount of all Sale
representing a transactions
signed 64-bit
real number
A string
Returns the
value
transaction count of
representing a all Sale transactions
signed 32-bit
integer
A string
value
representing a
date and time
Returns the date on
which the
transaction is
settled
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
82
One Solution. Higher Profits
SCM API Guide
Settle_Flag_CH
A string
Returns if the
value
transaction is
representing a settled or not
Boolean
value
StateCode_CH
A string
value up to
10 characters
Returns the state
code
Street_CH
A string
value up to
25 characters
Returns the billing
street address of the
credit card
A string
Returns the sure
value
charge amount of a
SureCharge_Amt_MN representing a transaction
signed 64-bit
real number
Tip_Amt_MN
A string
Returns the tip
value
amount of a
representing a transaction
signed 64-bit
real number
Total_Amt_MN
A string
Returns the total
value
amount of a
representing a transaction
signed 64-bit
real number
Trans_Type_ID
A string
value up to
Returns the
transaction type,
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
83
One Solution. Higher Profits
SCM API Guide
20 characters
e.g. Sale, Credit
Transport_Method
A string
Returns the
Transportation
Method
Only for use
with Dial-up
transactions
Transport_EndPoint
A string
Returns the
Transportation’s
Ending Destination
Only for use
with Dial-up
transactions
Returns the
transit/routing
number
This field will be
masked out with
asterisk (*)
characters except
for the last 4
digits if the
System Security
Level of the user
is set to 1
TransitNum_VC
A string
value up to
200
characters
TRX_Card_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
TRX_Card_T table
in the database
TRX_Check_Key
A string
value
representing a
signed 32-bit
integer
Returns the primary
key of the
TRX_Check_T
table in the database
A string
value
Returns the primary This field is the
key of the
unique
TRX_HD_Key
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
84
One Solution. Higher Profits
SCM API Guide
representing a TRX_Header_T
transaction
signed 32-bit table in the database identifier (also
integer
called PNRef) of
the Payment
Server. Use its
value when
submitting
transactions
based on a
previous
transaction (i.e.
Voids) through
the
Transact.asmx
Web Service
TRX_Settle_Key
A string
value
representing a
signed 32-bit
integer
A string
TRX_Settle_Msg_VC value up to
25 characters
Returns the primary
key of the
TRX_Settle_T table
in the database
Returns the
transaction’s
settlement message
Type_CH
A string
value up to
10 characters
Returns the credit
card type, e.g.
VISA,
MASTERCARD
User_Name_VC
A string
value up to
25 characters
Returns the
username, under
which the
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
85
One Solution. Higher Profits
SCM API Guide
transactions were
made
Void_Flag_CH
Zip_CH
A string
Returns the
value
transaction is
representing a voided or not
Boolean
value
A string
value up to
10 characters
Returns the billing
zip code of the
credit card
Response Values
Result Response Field Definitions (Error 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
that when programmatically validating a transaction’s result, this value should be
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
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
86
One Solution. Higher Profits
SCM API Guide
-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
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
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
87
One Solution. Higher Profits
SCM API Guide
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
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
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
88
One Solution. Higher Profits
SCM API Guide
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
1005
Transaction Type Not Allowed
1006
Unsupported Processor
1007
Invalid Request Message
1008
Invalid Version
1010
Payment Type Not Supported
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
89
One Solution. Higher Profits
SCM API Guide
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)
AVS 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-digit Zip matches, address doesn’t
W
Whole Zip: 9-digit Zip matches, address doesn’t
N
No: Neither address nor Zip matches
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
90
One Solution. Higher Profits
SCM API Guide
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
Not Supported: Issuer doesn’t support AVS service
B
* Street Match: Street addresses match for international transaction, but
postal code doesn’t
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 address doesn’t
0
** No response sent
5
Invalid AVS response
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
91
One Solution. Higher Profits
SCM API Guide
* These values are Visa specific.
** These values are returned by the Payment Server and not the processor.
CV 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
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
92
One Solution. Higher Profits
SCM API Guide
Valid Parameter Input Characters
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.
Table 1. Valid Data Characters
DEC
HEX
Chara
cter
DE
C
HE
X
Chara
cter
32
33
34
35
36
37
38
39
40
41
42
43
44
20
21
22
23
24
25
26
27
28
29
2A
2B
2C
Space
!
"
#
$
%
&
'
(
)
*
+
,
63
64
65
66
67
68
69
70
71
72
73
74
75
3F
40
41
42
43
44
45
46
47
48
49
4A
4B
?
@
A
B
C
D
E
F
G
H
I
J
K
DEC
HEX
96
97
98
99
100
101
102
103
104
105
106
107
108
60
61
62
63
64
65
66
67
68
69
6A
6B
6C
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
C
h
a
r
a
ct
e
r
`
a
b
c
d
e
f
g
h
i
j
k
l
93
One Solution. Higher Profits
SCM API Guide
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
2D
2E
2F
30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
.
/
0
1
2
3
4
5
6
7
8
9
:
;
<
=
>
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
92
94
95
4C
4D
4E
4F
50
51
52
53
54
55
56
57
58
59
5A
5C
5E
5F
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
\
^
_
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
6D
6E
6F
70
71
72
73
74
75
76
77
78
79
7A
7B
7C
7D
7E
m
n
o
p
q
r
s
t
u
v
w
x
y
z
{
|
}
~
Character 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
ensures that the Payment Servers’ internal XML parsers can properly read the
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
94
One Solution. Higher Profits
SCM API Guide
information of the Web Service operation. Characters in the table are displayed
in Courier New font.
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. XML Character Removal
Character
<
>
&
'
"
XML Parser Encoding
&lt;
&gt;
&amp;
&apos;
&quot;
Example
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
© 2010. Affinity Payments doing business as PayLeap, is a registered ISO/MSP of Wells Fargo Bank, N.A.,
Walnut Creek, CA.
95
One Solution. Higher Profits
SCM API Guide
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.
96