Beruflich Dokumente
Kultur Dokumente
Table of Contents
About this Document ............................................................................................................................. 4
Copyright Notice ................................................................................................................................................................. 4 Trademark Notice ............................................................................................................................................................... 4 Interchange Qualifications and Transaction Rates ............................................................................................................. 4 Publication History .............................................................................................................................................................. 5 Documentation Conventions............................................................................................................................................... 5 Definitions of Variable Types .......................................................................................................................................... 6 Permitted Syntax for Variable Fields .............................................................................................................................. 6 Obtaining Additional Information......................................................................................................................................... 7 Obtaining Referenced Documents ................................................................................................................................. 7 Contacting Skipjack Financial Services .............................................................................................................................. 7
Blind Credits........................................................................................................................................ 19
Prerequisites and Requirements for Performing Blind Credits ......................................................................................... 19 szReturnCode Error Messages Associated with Blind Credits .................................................................................... 19 Using Blind Credits versus Change Status: Credit ........................................................................................................... 19 Configuring the Skipjack Merchant Account to Permit Blind Credits ................................................................................ 20
Page 2 of 43
Mapping the Transaction Variables to E-mail Template Variables................................................................................... 27 E-mail Template Tags ....................................................................................................................................................... 28 Mapping Skipjack Variables to the E-mail Template ........................................................................................................ 29 Additional Transaction-Generated Variables for E-mail Responses ................................................................................ 30 E-mail Lists - Creating E-mail Lists ................................................................................................................................... 31 Web Page Response Files ............................................................................................................................................... 32 Changing the Web Response Files .................................................................................................................................. 32
Skipjack_Integration_Overview_Guide_Version1.0_RevM1.doc
Page 3 of 43
Copyright Notice
2008 Skipjack Financial Services. All rights reserved. The information contained herein is for information purposes only. Skipjack makes no warranty, expressed or implied, in this document. No part of this information may be reproduced in any form or by any means or transferred to any third party without the prior written consent of Skipjack Financial Services.
Trademark Notice
All trademarks, registered trademarks, and service marks mentioned or used within this document are owned wholly by their respective owners.
Page 4 of 43
Publication History
Date August 2008 Version Version1.0_RevM1 Comments First version of this guide for release in this format. Content moved from the Skipjack Integration Guide (SIG) as part of Skipjack Integration Guide restructuring.
Documentation Conventions
The material presented in this guide uses the following text conventions throughout, where applicable.
Convention Courier text Usage Code Snippets, HTML Code, Skipjack Transaction Network Request Response Examples text Browser Elements, Fields Names, and Menu Items, Emphasis Notes Hyperlinks (links) to external resources on the Web. Click on these to go to the document or web site identified by the link. Primary use is to denote crossreferences (clickable hotlinks in the PDF version) to a location within this document. Also used within tables in this document to enclose characters that might otherwise be overlooked. Italics Document Title See the Skipjack Integration Guide for details. Example <form name="Button" action="https://vpos.skipjack.com/ezPay/order. asp" method="post"> click on a Submit button. make sure you enter your HTML Serial Number.... Note: You must consider the following when Visit http://www.skipjack.com to learn more about Skipjack Financial Services.
Bold text
Blue Underline
Quoted text
See the About this Document section for details. This field can also include the . (period) character.
Page 5 of 43
All Characters
"~`!@#$%^&*()_-+= only
Page 6 of 43
Page 7 of 43
Page 8 of 43
Page 9 of 43
Name-Value Pairs
Data is securely sent between your application and the Skipjack Transaction Network as name-value pairs across the Internet as an HTTPS POST request. The response returned from the Skipjack Transaction Network is formatted as a comma-delimited text string with records separated by carriage return/line feed (CR/LF) breaks.
Page 10 of 43
Your Application
Page 11 of 43
Page 12 of 43
Once the transaction data successfully completes Validation the transaction data is sent to the Processor for the Authorization Phase. For szReturnCode values see the section in the Skipjack Integration Guide.
A final Approval (or Decline) of the transaction is based on the aggregate outcome of each of the variables and return codes. A final filtering (if enabled on Skipjack Transaction Network) is done in the form of AVS filtering. An Approval means that the Merchant has the promise that the funds are reserved for the transaction amount and product or services can be delivered to the Customer. The actual transfer of funds from the Issuing Bank to the Merchants Account requires a separate set of transaction processing to be performed later, usually at the end of the business day. This process, called the Settlement Process, is described in more detail in the Overview of the Credit Card Settlement Process.
Batch Settlement
Batch Settlement (also called off-line Settlement) is the most common mechanism used for transaction Settlement. Batch Settlement is the most practical and cost effective mechanism because for transaction since it makes efficient use of network resources. Batch Settlement is the most common and preferred method by Processors and Banks and as such Batch Settlement incurs lower fees from the Processors and Banks involved.
Page 14 of 43
action on the Merchants part to Settle transactions and Credits. Accounts set to Automatic Daily Settlement results in a Settlement Batch being initiated every 24 hours at the same time. All transactions in the Settlement Batch (all Approved transactions and Credits) that are in the Pending Settlement state are then Settled. The Settlement Batch close time and batch Settlement submission time can both be configured from the Skipjack Merchant Account Interface to control the timing of Automatic Daily Settlements. 2. Manual Daily: This configuration option requires that the Merchant to specify which transactions are to be Settled for each Settlement batch. Any Approved transactions which are marked for Settlement, along with all Credits, will be submitted for Settlement in a Settlement Batch once a day. The time specified in the Settlement Batch configuration options will dictate when the Settlement Batch is submitted. There is no need for the Merchant to close the batch since it will be closed and queued automatically at the configured time. 3. Manual None: This Settlement Batch configuration options requires that the Merchant specify which Approved transactions be marked for inclusion in each Settlement Batch. This option requires the Merchant to close the Settlement Batch prior to all marked transactions being submitted for Settlement. Care must be taken to prevent duplicate submission of the Settlement Batch, as described below. Note: If multiple Settlement requests are sent within the time that it takes the Skipjack Transaction Network to write the record to the database it is possible that multiple Settlements may occur. Double Settlement typically can occur if: I. The Merchant Settles a transaction in Merchant Services then goes back to the Web browser and Settles again without refreshing the browser display. II. Merchant uploads using the Change Transaction Status method to the Skipjack Transaction Network twice in quick succession. 4. Never None: This Batch Settlement configuration option sets all transactions, both Approvals and Credits, to never Settle, effectively locking the transactions into their current state. This option could be used, for example, in very special circumstances, such as when a Merchant is changing banks or Processors and wishes to delay Settling transactions until the changeover is complete.
Page 15 of 43
Real-Time Settlement
One type of transaction Settlement is real-time Settlement. Real-time Settlement submission can be set by setting the Merchant Account to Manual Daily and forcing a transaction to Settle using the szForceSettlement variable (flag) of the in the Change Transaction Status method. Real-time Settlement is not normally applied to individual credit card transactions because Processors and banks impose high fees for submitting more than a single transaction Settlement batch. These fees would be very costly for settling each transaction in real time, particularly in highvolume environments. Real-time Settlement may only be practically used in very special circumstances. Contact Skipjack Financial Services if you are contemplating using this option to determine whether or not this is viable or if an alternative Settlement option would be more suitable.
Page 16 of 43
Page 17 of 43
Core Methods
The Core transaction methods are fundamental methods that perform the most widely used transaction functions. The Core methods are: 1. Authorize and AuthorizeAPI 2. Get Transaction Status 3. Change Transaction Status
Supplementary Methods
The Supplementary methods are those that are used in conjunction with the Core methods to perform more specialized or tertiary operations on transactions. The available Supplementary Methods for transaction processing: 1. Recurring Payments a) Add Recurring Payment b) Get Recurring Payments Status c) Delete Recurring Payment d) Edit Recurring Payment 2. Batch Upload a) Batch Authorization b) Check Batch File Status c) Modify (Edit) Batch File Status d) Get Batch File Response 3. Reports API a) Transaction Detail Report b) Daily Deposit Summary c) Batch Summary Report d) Customized Report 4. Batch Settlement a) Close Current Open Batch b) Get Batch Settlement Status For detailed integration detailed about each of these Skipjack Financial Services transaction processing methods see the Skipjack Integration Guide and Skipjack Reporting Integration Guide.
Page 18 of 43
Blind Credits
A Blind Credit is a Credit (Refund) applied to a transaction for which a record is not currently held within the Merchant Register (Skipjack Transaction Network database). A Blind Credit may be required when a Merchant moves their business from another payment gateway to Skipjack Financial Services and a customer requests a Credit to be applied to transactions previously processed by the other payment gateway. When submitting a Blind Credit using the Authorize/AuthorizeAPI methods (see the Skipjack Integration Guide for details) a negative TransactionAmount is specified in the Transaction Amount variable. To perform a Blind Credit the Merchant must obtain all credit card information from the customer (Account Number, Name, Expiry, CVV code, etc.) in order to complete the Blind Credit.
Page 19 of 43
Blind Credits are used in situations where the original transaction was processed using a competitors payment gateway. Therefore, it is necessary to re-enter all credit card information or swipe the credit card to complete the Blind Credit transaction. You would use the Authorize/AuthorizeAPI method specifying a TransactionAmount with a negative value to complete a Blind Credit.
4. Select the check-box beside the Allow Blind Credit to enable this configuration option on the Skipjack Merchant Account. 5. Click the Submit button to make the changes to the configuration settings. NOTE: If you are not able to access Account Setup Page configuration page you do not have the required account permissions to make these changes. Contact the Skipjack Financial Services Customer Support and request these configuration changes be applied to your Skipjack Merchant Account or obtain access privileges needed to configure these account options.
Page 20 of 43
Page 21 of 43
Configuring the Reject Duplicate Order Numbers Option for a Merchant Account
By default the Skipjack Merchant Account is configured to permit duplicate Order Numbers for a Skipjack Merchant Account. Typically this configuration is not problematic or is actually preferred for testing certain application behaviors in a Development environment. However, rejecting transactions based on duplicate order numbers is recommended for Skipjack Merchant Accounts that are processing Live transactions. Depending on your Skipjack Merchant Account permissions, your Skipjack Merchant Account settings may allow or reject transactions based on Order Number duplicates. To set the Reject duplicate transactions based on order number settings Merchant Account options: 1. Login to the Merchant Account at https://secure.skipjack.com. 2. Select the Edit Account button in the bottom section of the Account Summary page to display the Account Setup Page. 3. Scroll down the page to the Reject duplicate transactions based on order number section. You should see the section shown below: 4. Select the check-box beside the option to toggle the option on and off. This option is set when the checkmark is displayed in the check box (selected).
5. Select the Submit button to invoke the changes. 6. Use your Web browsers Back button to return to previous pages to continue working or select the Exit link to log out of the Merchant Register.
Page 22 of 43
Note: If you are not able to access Account Setup Page, you do not have the required account permissions. Contact the Skipjack Financial Services Support to have this configuration change applied to your Skipjack Merchant Account.
Page 23 of 43
For information about the above mentioned Batch Settlement functions that must be configured using the Merchant Services Interface, see the Skipjack Merchant Services Guide.
Page 24 of 43
Options for Setting E-mail Response Settings in the Merchant Account Interface
There are four configuration settings that can be used to control to whom the e-mail responses are sent, as described in the table below.
E-mail Type Notify Merchant Notify Customer E-mail List Description This option enables Merchants to receive confirmation of order information. This option enables Customers to receive confirmation of order information. An e-mail list allows Merchants to add other e-mail recipients to receive confirmation of order information. This entry populates the From field with the Merchants desired e-mail address for all e-mails that are sent to Customers. Configuration Location Within Merchants Account Preferences on the Merchant Interface. Within Merchants Account Preferences on the Merchant Interface. Within the Web Page Response files for the appropriate vendor account. Configured during Skipjack Merchant Account set up.
Originating E-mail
Note: Do not add duplicate e-mail addresses or the Merchants e-mail address to an e-mail list response. Enabling E-mail Responses to Customers and Merchants on the Merchant Interface
Page 25 of 43
Page 26 of 43
NOTE: Use the Edit button to make your changes, or select the Reset button to discard the changes and set the default templates provided by Skipjack.
Page 27 of 43
Page 28 of 43
Shiptophone Streetaddress2 Streetaddress3 Streetaddress4 Country Phone Fax Shiptoname Shiptostreetaddress Shiptostreetaddress2 Shiptostreetaddress3 Shiptostreetaddress4 Shiptocity
Page 29 of 43
The State or Province to where the item is shipped. The Zip or Postal Code of the shipping address. The country to where the item is to be shipped. The fax number of the person or organization where the item is shipped. CVV value on credit card used in transaction. This is not available for inclusion. Information contained in the comment field. Information contained in the user defined field.
The tag <UserDefinedFields> can be requested in the e-mail templates. These UserDefinedFields cannot be requested with specific <tags> they must be requested as a group. This tag will return ALL of the User Defined Variables in a group (maximum of 30 user defined fields are available). Each variable will be separated by a line break.
Page 30 of 43
Page 31 of 43
You can configure the Merchant Account to use Web Response Files other than the above listed defaults.
Page 32 of 43
5. If you wish to use custom pages, select either the Edit or View button for the page type you wish to edit or view. 6. To Edit a page, select the Edit button for the page you wish to change (there are 4 choices). The HTML code of the page your wish to edit is displayed in a window. 7. In the window, edit, paste, or write new code as required for the customized response message you wish Customers to see. 8. When you have finished editing your HTML code, select the Save button to save the changes. If you have successfully updated the Web Response Files this is indicated by the confirmation message displayed. 9. Use the Back button on your Web browser to navigate back to the Account Summary page to continue working within the Merchant Services Interface. Note: Because of the JavaScript used for the redirect never use the word submit" for the Submit button on any form that posts to SkipjackIC. When using the Skipjack redirect, the name "submit" is reserved. Use another appropriate word instead.
Page 33 of 43
Security Information
This section contains information about security-related issues and how security is handled for transactions within the Skipjack Transaction Network.
Page 34 of 43
Page 35 of 43
Testing Guidelines
Testing can be performed in the Development phase using the Skipjack Transaction Network Development (Test) environment and a test credit card. This allows developers ensure that their application functions correctly.
Page 36 of 43
Page 37 of 43
Reports
Developers must use the Developer (Demo) credentials while their application is in the testing phase and will be issued a new, Live (Production) Vendor (Login) Serial Number, once they migrate from the Development environment to the Production environment. Merchants must use the Live (Production) credentials to Login to the Live area once their application has been launched in the Production environment.
Page 38 of 43
Passwords that do not use all three types of characters or are not the correct length will be rejected.
Page 39 of 43
Authorization Testing
Test your application for Authorization using the following testing guidelines: 1. Test all credit card types that your Skipjack Account will accept on the Development Platform (Visa, MasterCard, American Express, JCB, Discover, Diners Club). Test cards for use in the Development environment are listed above in the Test Cards Used with Development Accounts for Integration Testing section. 2. When testing is successful on the Development platform retest on the Production Account prior to making the application publicly accessible (before going Live). 3. Use real (Live) credit cards, whenever possible, especially when the test is being conducted on a Production Account. 4. Ensure that each transaction is Approved and is listed as Approved in the Merchant Services Register for every Authorization submitted. 5. Ensure that there is a valid Approval Code returned for every tested transaction. 6. Ensure a unique Order Number (Ordernumber variable) is used for each transaction. 7. Ensure that all variables posted to the Skipjack Transaction Network are being returned with valid data for each transaction. You should review these within the Merchant Services Register as well as from with your application. 8. Delete all test transactions (Authorizations) before they are Settled if you do not wish to proceed with Settlement testing, as described below.
Page 40 of 43
Response Testing
Please ensure that each of the following Skipjack Transaction Network system responses are functioning as intended. This section will describe the basic checks and tests that should be performed on system responses.
E-mail Response
Ensure that the e-mail response to the Merchant and/or Customer contains the correct information with the appropriate variables and the wording of the e-mail is appropriate and accurate (For example you should confirm that the phone number, contact information, and similar information is correct within e-mail responses.) Test and check that the correct Merchant recipient(s) are receiving the appropriate e-mail notifications for each transaction.
Response Page
Ensure that the Response Page displayed to the Customer contains the correct information, is properly worded, and is displayed for each transaction. This can be tested using test credit cards on Test Accounts by submitting test Approval and Decline for transaction Authorization.
Third-Party Applications
Ensure that any third-party applications that are being updated with response information are properly receiving all information correctly and in a timely manner
Functional Testing
Test that all applicable functions within the application (such as the Change Status method, Get Status method, error checking, scripts, etc.) are working properly without errors.
Page 41 of 43
Select the Knowledgebase link to access the online topics. Information is organized in a topical manner with most recent articles listed for easy selection, as shown above.
Page 42 of 43
Page 43 of 43