|
POS-partner API Overview
This overview is included in the API SDK available for download from the Download Center on this Web Site. This document provides a description of the POS-partner API used by merchants to provide connectivity to the TSYS Acquiring Solutions' platform, and includes details of the following:
- API Configuration
- File Transfer Methods
- Request File Contents
- Merchant Transaction ID
- Response File Contents
- Response Error File Contents
|
- Maximum File Size
- Encryption
- Error Handling
- XML Overview
- XML Schema
|
The
POS-partner Overview should be used as a reference during the development
of your application in addition to the POS-partner API documentation supplied
in the SDK.
The
POS-partner API SDK also includes:
- Sample Files
- Sample Applications
- Source Code
- XML Schema for POS-partner API
- API Diagrams
Developing Applications that use the POS-partner API
Using
the POS-partner Overview, and the additional content of
the POS-partner API SDK as a road map, you
can quickly develop a basic application interface.
Once
you are comfortable that you understand the POS-partner API concept
and have developed an application design and testing plan, you can begin
testing using the TSYS Acquiring Solutions POS Test Platform.
The
POS-partner API is an active API which requires a valid destination
host and POS-partner Application Server configuration to process transactions.
Subsequently, you cannot use or test the API when logged into POS-partner in training or demonstration mode.
How to
get API Approval
| Step 1: |
Complete
a stand-alone or Server Installation of POS-partner. It is highly recommended that your testing platform not interfere with an existing POS-partner server in production. When the installation is complete, you will automatically be prompted to begin the activation process. If you intend on applying for a test merchant profile, or have not yet received your activation file, it is suggested you choose to cancel activation at this time. When you receive your activation file, you can run the activation wizard to complete the process.
If you choose to use your existing production server, you cannot change or add an additional test host. Conversely, after testing is completed, you cannot activate your test server with a live merchant profile; you will have to uninstall and reinstall POS-partner.
The
latest version of POS-partner may be obtained from this Web Site
via the Download Center. You will be required to register with TSYS Acquiring Solutions prior to downloading files, documentation, etc., from this Web site. Both installation and configuration assistance can be enlisted by contacting PC Technical Support at (800) 847-2772.
|
| Step 2: |
Please download, complete in its entirety, and return the Developer Registration Profile. While most test merchant builds can be completed in a few hours, please allow up to 48 hours to complete your request.
TSYS Acquiring Solutions will record your application information in
its internal databases for reference during the compatibility testing
process.
Please return the completed profile to TSYS Acquiring Solutions via one of the following methods:
| Mail: |
TSYS Acquiring Solutions
Attn: PC Technical Support/Developer Registration
C/O POS Support Services
8320 South Hardy Drive
Tempe, AZ 85284-2007 |
| E-mail: |
apisupport@tsysacquiring.com |
|
Step 3: |
On receipt of the API Developer Registration Profile, a test Merchant Activation (MAD) file will be sent to the primary developer's e-mail address. Using the POS-partner activation wizard (link is located in your POS-partner set-up group) to activate your Partner with a test hierarchy, you can begin your preliminary testing using either live credit card account information (without impact to the card holder) or test card data (if available).
Important: When using live card account information in your test files, it should be understood that if you are requested to send your test files to TSYS Acquiring Solutions for additional testing or final approval, it is your responsibility to remove any and all sensitive data, or otherwise properly encrypt and password-protect access to your attachments, before sending this information, unsecured, over the Internet. Passwords, required to obtain access or open these files should be sent in a separate message. Please note that it is not necessary to send card information to test your files. Contact your merchant services provider if you have additional questions.
TSYS Acquiring Solutions does not provide test cards or numbers. It is the Developers responsibility to obtain test credit cards and/or card numbers.
|
Step 4: |
Develop the application to interface with the API according to POS-partner Overview and SDK.
Note:TSYS Acquiring Solutions does not support the actual development of your POS-application or provide instruction on the writing or reading of XML documents beyond what is provided in the SDK included samples; please do not ask us to assist in the development of your application.
Should you have questions during your development, or for general API or POS-partner technical support, please contact PC Technical Support at (800) 847-2772 or send your inquiries to apisupport@tsysacquiring.com.
|
Step 5: |
Upon successful completion (i.e., no known errors), please send copies of both the request and response files for each transaction type you specified on the Developer Registration Profile to apisupport@tsysacquiring.com. Your files will be tested and reviewed to ensure that your system complies with the requirements set forth in the API Overview and the TSYS Acquiring Solutions POS Platform.
Note: While our technicians may suggest changes to your process that will affect interchange rates, it is the sole responsibility of the developer and/or end user to verify with their merchant services provider that all requirements are being met and that you qualify for proper interchange.
On verification of the above requirements, TSYS Acquiring Solutions will, upon request, provide written notification of your meeting said requirements, should this be required by any certification entity. |
Testing Constraints
Load Testing: |
Do
not perform application load testing during peak business hours: between 8 a.m. and 5 p.m. Arizona time. Please keep load test volumes to 1000 transactions or less in any
one test.
|
| Maximum Batch Amount: |
$99,999.99
|
| Maximum Transaction Count: |
The
TSYS Acquiring Solutions POS Test Platform is currently designed to limit batches of
less than 30,000 transactions without Enhanced Line Item Detail
data. |
General Information
TSYS Acquiring Solutions reserves the right to require additional tests and review approval status from time to time to ensure that developers conform to the current
requirements.
Development time frame varies based on the skills, experience and resources
of the developer.
PC Technical Support is available to you during your development
process to consult or discuss issues related to the development of your
application.
Should you have any questions, please call PC Technical Support at
(800) 847-2772.
On occasion, you may find that it is necessary to update your developer profile to ensure that we have accurate information on file for your company and/or product.
Contacting
the PC Technical Support
|
US
Mail: |
TSYS Acquiring Solutions
Attn: PC Technical Support/Developer Registration
C/O POS Support Services
8320 South Hardy Drive
Tempe, AZ 85284-2007 |
|
E-mail: |
apisupport@tsysacquiring.com. E-mail inquiries will receive a reply within 24 hours or one business day. |
|
Phone/Hours: |
(800) 847-2772 - 24 hours a day, seven days a week. |
|