Transcription of TC L API DEVELOPER GUIDE - TrustCommerce Vault
1 2017 TrustCommerce . All rights reserved. TC LINK API DEVELOPER GUIDE Version Note: This document is classified for Client Use Only. Clients, resellers and referral partners are provided these documents for their own internal use, and may not disseminate, copy, or distribute them externally. TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | i Contents About TC Link .. 1 What is TC Link? .. 1 How TC Link Works .. 1 Intended Audience for This GUIDE .. 2 Where to Go for More Information .. 2 TC Link Functions .. 2 TC Link 3 Rules .. 3 Supported Payment Types and Industry Segments .. 4 Supported Payment Types .. 4 Supported Industry Segments .. 4 Getting Started with TC Link .. 5 Supported Platforms .. 5 Installing TC Link .. 5 Network Configuration.
2 5 TrustCommerce IP Blocks .. 5 Testing Your Connection .. 7 Windows XP .. 7 Windows Vista or Windows 7 .. 7 UNIX/Linux .. 8 Your First Transaction .. 9 Sample TC Link (Java) .. 9 Sample Compile and Response .. 10 Basic Transaction Processing .. 11 Basic Transaction Requests .. 11 Required Fields .. 11 Basic Transaction Responses .. 12 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | ii TransID .. 12 Status .. 12 Testing Your Application .. 14 Test Data .. 14 Test Cards - Approved .. 15 Test Cards - 15 ACH Test Numbers .. 16 Sale (Authorization and Host Capture) .. 17 Sale Required Fields .. 17 Sale Suggested and/or Other Notable Optional Fields .. 17 Sale common Responses .. 18 Sale Transaction Example .. 18 Preauth (Authorization Only) .. 19 Preauth - Required Fields.
3 19 Preauth - Suggested and/or Other Notable Optional Fields .. 20 Preauth - common Responses .. 20 Preauth Transaction Example .. 21 Postauth (Capture Only) .. 22 Postauth - Required Fields .. 22 Postauth - Suggested and/or Other Notable Optional Fields .. 22 Postauth - common Responses .. 22 Postauth Transaction 23 Offline Sale (Offline Authorization) .. 24 Offline Sale - Required Fields .. 24 Offline Sale - Suggested and/or Other Notable Optional Fields .. 24 Offline Sale - common Responses .. 25 Offline Authorization Example .. 25 Verify (Card Verification) .. 26 Verify - Required Fields .. 26 Verify - Suggested and/or Other Notable Optional Fields .. 26 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | iii Verify - common Responses .. 27 Verify Example .. 27 Credit (Refund).
4 28 Credit - Required Fields .. 28 Credit - Suggested and/or Other Notable Fields .. 28 Credit - Amount Field .. 28 Credit - common Responses .. 28 Credit Example .. 29 Credit2 (Standalone Refund) .. 30 Credit2 Required Fields .. 30 Credit2 Suggested and/or Other Notable Fields .. 30 Credit2 common Responses .. 30 Credit2 Example .. 31 Void (Void Transaction) .. 32 Void - Required Fields .. 32 Void - common Responses .. 32 Void Transaction Example .. 32 Reversal (Reversal Transaction) .. 33 Reversal Required Fields .. 33 Reversal - Suggested and/or Other Notable Fields .. 33 Reversal common Responses .. 34 Reversal Transaction Example .. 34 Chargeback .. 35 Chargeback Required Fields .. 35 Chargeback common Responses .. 35 Chargeback Transaction Example .. 36 About Transaction Responses .. 37 General Fields .. 37 Transaction Status.
5 38 Returned Transaction Statuses .. 38 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | iv Approved or Accepted .. 38 Decline Type .. 39 Declinetype Fields .. 39 Error Response .. 40 Error Fields .. 40 Error 41 errortype Fields .. 41 Response Field Groups .. 42 Response Code .. 42 Payload Sent Field .. 42 Platform .. 43 Baddata .. 43 Server .. 44 Client .. 44 Card Present (CP) .. 46 Card Swipe Processing .. 46 Track Data .. 46 Card Swipe Fields .. 46 Card Swipe common Responses .. 47 Card Swipe Transaction Example .. 47 Encrypted Card Swipe Processing .. 48 Encrypted Card Swipe Fields .. 48 Encrypted Card Swipe - common Responses .. 48 Encrypted Card Swipe Transaction Example .. 49 Digital Signature Capture .. 49 Signature Capture Fields .. 49 Signature Capture - common Responses.
6 50 Signature Capture Transaction Example .. 50 Card Not Present (CNP) .. 51 E-Commerce or Mail Order/Telephone Order .. 51 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | v E-Commerce and MOTO Fields .. 51 E-Commerce and MOTO common Responses .. 51 E-Commerce and MOTO 52 Debit .. 53 Signature Debit .. 53 PIN-based Debit .. 53 PIN-based Debit Sale Fields .. 54 PIN-based Debit common Responses .. 54 PIN-based Debit Sale Example .. 55 PIN-less Debit .. 56 PIN-less Debit Fields .. 56 PIN-less Debit common Responses .. 56 Submitting a PIN-less Debit Sale .. 57 Using PIN-less Debit BIN Lookup .. 57 Electronic Checks/ACH .. 58 ACH Fields .. 58 ACH common Responses .. 58 Electronic Check Transaction Example .. 59 Purchase Card .. 60 Purchase Level 60 Purchase Level II Fields.
7 60 Purchase Level II common Responses .. 61 Purchase Level II Transaction Example - Sale .. 61 Purchase Level II Transaction Example - Postauth .. 62 Purchase Level III .. 62 Purchase Level III Integration .. 63 Purchase Level III Fields .. 63 Line Item Data .. 64 Purchase Level III - Line Item Data .. 64 Purchase Level III common Responses .. 65 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | vi Purchase Level III Transaction Example .. 66 Inventory Information Approval System (IIAS) .. 67 IIAS Transaction Fields .. 67 Healthcare Eligible and Prescription Amount Fields .. 67 IIAS Sale Transaction Examples .. 68 Example I .. 68 Example II .. 68 Example III .. 69 Example IV .. 70 IIAS Reversal Transaction Example .. 70 IIAS Partial Authorization Response Field.
8 70 Recurring/Installment Payments (Non TC Citadel) .. 72 Recurring/Installment Fields .. 72 Recurring/Installment common Responses .. 72 Submitting a Recurring/Installment Payment .. 73 Restaurant (Tip) .. 74 Restaurant Fields .. 74 Restaurant Transaction Example .. 74 Initial Preauth .. 74 Postauth with Tip .. 74 TC Citadel .. 75 TC Citadel Fields .. 75 Creating a Billing ID .. 76 TC Citadel Responses .. 76 Verifying a Billing ID .. 77 Verify - common Responses .. 77 Unstoring a Billing ID .. 79 Unstore - common Responses .. 79 Updating a Billing ID .. 80 BillingID Updates - common Responses .. 80 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | vii Shared Access BillingIDs .. 81 Example Scenario .. 81 Sale Transaction on Existing BillingID .. 81 Continuity Payments: Recurring, Installment, and Deferred.
9 82 Recurring Payments .. 82 Installment Payments .. 82 Deferred Payments .. 82 Example .. 82 Continuity Payments - common Responses .. 83 One-Time Subscription Transactions .. 84 One-time Subscription Payments - common 84 One-Time Payment .. 85 One-time Payments - common 85 Fraud Score .. 86 Fraud Threshold .. 86 Using Fraudthreshold .. 86 Fraudthreshold - Returned Values .. 87 Blacklists .. 88 Handling Blacklist Responses .. 88 Velocity .. 89 Velocity Fields .. 89 Velocity Transaction Example .. 89 Velocity - Returned Values .. 90 Address Verification System (AVS) .. 91 AVS Field .. 91 Using AVS .. 91 Handling AVS Return Codes .. 92 Card Security Code (CSC) .. 93 Card Security Code Fields .. 93 Using Card Security Codes (CSC) .. 94 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce . All rights reserved. Client Use Only Page | viii Handling CVV Response Codes.
10 94 Discretionary Fields .. 95 Ticket and Operator Fields .. 95 TC Transaction Custom Fields .. 95 TC Citadel Custom Fields .. 96 Query API .. 97 Best Practice .. 97 Email Receipts .. 98 TC Link API Request .. 98 Sale Transaction Example .. 98 TC Link API Receipt Status .. 99 HTTPS/POST Query Types .. 100 HTTPS/POST Query Fields .. 101 Query API TC Vault Example .. 102 TC Vault Query API Transaction ID Example .. 106 Enterprise Example .. 106 Format I: Comma-Delimited List .. 106 Format II: Range of CustIDs .. 107 TC Batch .. 108 Batch File Format .. 108 Naming Conventions .. 109 Batch Submission .. 109 cURL Example .. 109 Batch Upload Interface Example .. 110 Batch Response .. 111 Batch Results Download Interface Example .. 111 Batch Status .. 112 HTTPS/POST .. 113 TC Trustee API .. 114 Externally Integrated Applications .. 115 TC Link API DEVELOPER GUIDE Version Client Use 2017 TrustCommerce .