Transcription
Credit Card ServicesSimple Order APIChase Paymentech SolutionsDeveloper Guide
2021. Cybersource Corporation. All rights reserved.Cybersource Corporation (Cybersource) furnishes this document and the software described in this document underthe applicable agreement between the reader of this document (You) and Cybersource (Agreement). You may use thisdocument and/or software only in accordance with the terms of the Agreement. Except as expressly set forth in theAgreement, the information contained in this document is subject to change without notice and therefore should not beinterpreted in any way as a guarantee or warranty by Cybersource. Cybersource assumes no responsibility or liabilityfor any errors that may appear in this document. The copyrighted software that accompanies this document is licensedto You for use only in strict accordance with the Agreement. You should read the Agreement carefully before using thesoftware. Except as permitted by the Agreement, You may not reproduce any part of this document, store this documentin a retrieval system, or transmit this document, in any form or by any means, electronic, mechanical, recording, orotherwise, without the prior written consent of Cybersource.Restricted Rights LegendsFor Government or defense agencies: Use, duplication, or disclosure by the Government or defense agencies is subject torestrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 and in similarclauses in the FAR and NASA FAR Supplement.For civilian agencies: Use, reproduction, or disclosure is subject to restrictions set forth in subparagraphs (a) through (d)of the Commercial Computer Software Restricted Rights clause at 52.227-19 and the limitations set forth in CybersourceCorporation's standard commercial agreement for this software. Unpublished rights reserved under the copyright laws ofthe United States.TrademarksAuthorize.Net, eCheck.Net, and The Power of Payment are registered trademarks of Cybersource Corporation.Cybersource, Cybersource Payment Manager, Cybersource Risk Manager, Cybersource Decision Manager, andCybersource Connect are trademarks and/or service marks of Cybersource Corporation. Visa, Visa International,Cybersource, the Visa logo, and the Cybersource logo are the registered trademarks of Visa International in the UnitedStates and other countries. All other trademarks, service marks, registered marks, or registered service marks are theproperty of their respective owners.Version: 21.08Credit Card Services 2
ContentsRecent Revisions to This Document. 7About This Guide. 9Introduction to the Credit Card Services.10Requirements for Processing Payments.10Cards and Payment Methods.10Debit Cards.10Discover Acquisitions and Alliances.11Types of Transactions.11Card-Present Transactions.11Card-Not-Present Transactions.12International Transactions.12Banks and Associations.13Acquiring (Merchant) Banks.13Issuing (Consumer) Banks.14Payment Card Companies. 14Supported Card Types. 14Order Tracking.16Request IDs.16Reconciliation IDs. 16Payment Card Processing.18Authorizations. 18Workflow for an Online Authorization.18Offline Authorizations. 19Required Fields for an Authorization. 20Authorizing a Payment. 22Example: Authorization (NVP).23Example: Authorization (XML). 24Authorization Reversals.25Processor-Specific Information.25Overview. 25Required Fields for an Authorization Reversal. 26Reversing an Authorization.27Credit Card Services - Contents 3
Contents 4Example: Authorization Reversal (NVP).27Example: Authorization Reversal (XML). 28Captures.28Overview. 29Workflow.29Required Fields for a Capture. 30Capturing an Authorization.31Example: Capture (NVP). 31Example: Capture (XML).32Sales.33Overview. 33Dual-Message Processing. 33Required Fields for a Sale. 34Performing a Sale.36Example: Sale (NVP).37Example: Sale (XML).38Follow-on Credits.39Overview. 39Workflow.40Required Fields for a Follow-on Credit.41Crediting a Payment with a Follow-on Credit. 41Example: Follow-on Credit (NVP).42Example: Follow-on Credit (XML). 43Stand-Alone Credits. 43Overview. 43Workflow.44Required Fields for a Stand-alone Credit. 45Crediting a Payment with a Stand-Alone Credit. 46Example: Stand-alone Credit (NVP).47Example: Stand-alone Credit (XML). 48Voids.49Overview. 49Required Fields for a Void. 50Optional Fields for a Void.50Voiding a Capture or Credit.50Credit Card Services - Contents 4
Contents 5Example: Void (NVP). 51Example: Void (XML).51Testing the Credit Card Services.53Requirements for Testing Credit Card Services. 53Testing the Credit Card Services.53Using Amounts to Simulate Errors. 55Testing American Express Card Verification. 55Required Features for Credit Card Processing. 56Authorization Reversal after Void (ARAV). 57Required Fields for an Authorization Reversal. 57Required Fields for a Void. 57Optional Fields for a Void.58Reversing an Authorization After a Void.58Example: Void (NVP). 60Example: Void (XML).60Example: Authorization Reversal (NVP).61Example: Authorization Reversal (XML). 62Automatic Partial Authorization Reversals. 63Card Types that Support Automatic Partial Authorization Reversals.63Automatic Partial Authorization Reversals Overview. 64Card Verification Numbers. 65Card Types that Support Card Verification Numbers. 65CVN Locations and Terminology.65CVN Results.66Required Field for an Authorization with a Card Verification Number.67Required Fields for an Authorization. 67Optional Fields for an Authorization with a Card Verification Number.69Authorizing a Payment with CVN. 69Example: Authorization with CVN (NVP).70Example: Authorization with CVN (XML). 71Standard AVS.73Processing AVS Codes. 73Controlling AVS Results.73Card Types that Support Standard AVS. 73No Required Fields for Standard AVS. 74Credit Card Services - Contents 5
Contents 6Required Fields for an Authorization. 74Optional Fields for Standard AVS. 76Example: Authorization with AVS (NVP).76Example: Authorization with AVS (XML). 77Debit and Prepaid Card Features. 79Partial Authorizations.79Supported Card Types. 80Unsupported Card Types.80How a Partial Authorization Works.81Required Field for Opting In (Enabling) Partial Authorizations. 82Required Field for Opting Out (Disabling) Partial Authorizations.82Required Fields for an Authorization. 82Required Fields for a Capture. 85Optional Field for Enabling and Disabling Partial Authorizations. 85Opting Out: Disabling Partial Authorizations.86Opting In: Enabling Partial Authorizations. 87Capturing a Partial Authorization. 87Example: Partially Approved Authorization (NVP).89Example: Partially Approved Authorization (XML). 91Real-Time Reversals. 93Balance Responses. 94Supported Card Types for Balance Responses. 94Features for Maestro (UK Domestic) Cards. 96Optional Features.97Credit Card Services - Contents 6
Recent Revisions to This Document21.08This revision contains only editorial changes and no technical updates.21.07Chase Paymentech SolutionsAdded information about the subsequentAuthTransactionID field to the followingMIT scenarios: Creating an authorization request for an installment payment in Credit CardServices Optional Features (Simple Order API). Creating an authorization request for a recurring payment in Credit Card ServicesOptional Features (Simple Order API). Creating an authorization request for an unscheduled COF transaction in CreditCard Services Optional Features (Simple Order API). Creating a request for a reauthorization in Credit Card Services Optional Features(Simple Order API).21.06API FieldsMoved the API field descriptions to the new API Field Reference Guide. See the API FieldReference for the Simple Order API.Visa CheckoutChanged to Visa Checkout to Visa Click to Pay.Visa Secure Remote Commerce21.05Removed this section.API FieldsUpdated the descriptions for the ccAuthReply merchantAdviceCode andccAuthReply merchantAdviceCodeRaw fields. For details about these fields, see theAPI Field Reference for the Simple Order API.Chase Paymentech SolutionsCredit Card Services - Recent Revisions to This Document 7
Added support for American Express with merchant-initiated transactions andcredentials-on-file transactions, which are described in Credit Card Services OptionalFeatures (Simple Order API).Added support for American Express with SCA exemptions. See the information aboutstrong customer authentication in Credit Card Services Optional Features (Simple OrderAPI).Removed support for zero amount authorizations with Discover.MasterpassRemoved support for Masterpass.Strong Customer Authentication21.04Updated the information about strong customer authentication, which is describedinCredit Card Services Optional Features (Simple Order API).Payment Network TokensAdded the tokenSource networkTokenOption request field.Added payment network token values to the paymentSolution field. This field is nowa request field and response field.21.03For details about these fields, see the API Field Reference for the Simple Order API.Merchant-Initiated Transactions (MITs)Updated the following information about merchant-initiated transactions, which aredescribed in Credit Card Services Optional Features (Simple Order API): Kinds of tokens that can be used for MITs. Usage for the subsequentAuthStoredCredential field for the MIT scenarios.Credit Card Services - Recent Revisions to This Document 8
About This GuideThis section provides you with information about the Simple Order API credit card services for ChasePaymentech Solutions.Audience and PurposeThis guide is written for application developers who want to use the Simple Order API to integratepayment card processing into an order management system.Implementing the credit card services requires software development skills. You must write codethat uses the API request and response fields to integrate the credit card services into your existingorder management system.ConventionsThe following special statements are used in this document:Important: An Important statement contains information essential to successfullycompleting a task or learning a concept.Warning: A Warning contains information or instructions, which, if not heeded, can result ina security risk, irreversible loss of data, or significant cost in time or revenue or both.Related DocumentationRefer to the Support Center for complete technical pport/technical-documentation.htmlCustomer SupportFor support information about any service, visit the Support Center:http://www.cybersource.com/supportCredit Card Services - About This Guide 9
Introduction to the Credit Card ServicesIn this document, the word processor can refer to processors, acquirers, or acquiring processorsdepending on your location.Requirements for Processing PaymentsPayment processors connect with acquiring banks. Before you can accept payments, you mustregister with a payment processor. Your acquiring bank might require you to use a paymentprocessor with which the bank has a business relationship.Your processor provides you with unique identification numbers for your account. You must providethese identification numbers to customer support.Cards and Payment MethodsThe credit card services can be used to process the following types of cards and payment methods: Credit cards—payments made with numerous types of credit cards can be accepted, includingVisa , Mastercard , American Express , Discover , Diners Club , and JCB . Private label cards—a private label card is a payment card that is issued by a private companyand that can be used only at the issuing company’s stores. If you are interested in processingtransactions for your company’s private label card, contact your account representative forinformation. Debit cards and prepaid cards—prepaid cards, Visa-branded debit cards, and Mastercardbranded debit cards can be processed with the credit card services. Quasi-cash—a quasi-cash transaction is a cash-like transaction for the sale of items that aredirectly convertible to cash.Debit CardsServices that you can use to process debit cards are: Credit card services—you can use credit card services to process payments with prepaid cards,Visa-branded debit cards, and Mastercard-branded debit cards.Credit Card Services - Introduction to the Credit Card Services 10
PIN debit services—you can use PIN debit services to process payments if your processorsupports PIN debit transactions.Discover Acquisitions and AlliancesThe following card types are processed on the Discover Network: China UnionPay Diners Club Discover JCB (US Domestic)For JCB cards, US Domestic means that the currency is USD and your location is the U.S., PuertoRico, Guam, U.S. Virgin Islands, or Northern Mariana Islands.Non-U.S. JCB transactions are routed through JCB.Your processor takes care of routing your transactions; you do not need to do any additionalprocessing to route these card types to the Discover Network.Types of TransactionsThis topic provides information about the following types of transactions: Card-Present Transactions (on page 11) Card-Not-Present Transactions (on page 12) International Transactions (on page 12)Card-Present TransactionsWhen a customer uses a card that is physically present to make a purchase, the purchase is knownas a card-present transaction. This type of transaction typically occurs in a retail environment. Toprocess card-present transactions, request the credit card services described in this guide andinclude card-present data in the requests.Related informationCard-Present Processing Using the Simple Order APICredit Card Services - Introduction to the Credit Card Services 11
Card-Not-Present TransactionsWhen a customer provides a card number but you do not have access to the physical card, thepurchase is known as a card-not-present transaction. This type of transaction typically occurs overthe Internet or through a call center. To process card-not-present transactions, use the credit cardservices described in this guide.Card-not-present transactions pose an additional level of risk to your business because you cannotdirectly verify the customer’s identification.Features, such as Address Verification System (AVS) and Card Verification Numbers (CVNs),are supported for the credit card services and can reduce that risk by verifying the customer’sinformation and notifying you when discrepancies occur.International TransactionsComplianceAccepting payments from a country other than your own requires that you observe the processingrules and practices of the payment systems in that country. The following list describes areas ofcompliance that are e
This section provides you with information about the Simple Order API credit card services for Chase Paymentech Solutions. Audience and Purpose This guide is written for application developers who want to use the Simple Order API to integrate payment card processing into an order management system.
