Transcription
Title PageRecurring BillingUsing the Simple Order API
Cybersource Contact InformationFor general information about our company, products, and services, go to http://www.cybersource.com.For sales questions about any Cybersource service, email sales@cybersource.com or call 650-432-7350 or 888330-2300 (toll free in the United States).For support information about any Cybersource service, visit the Support Center:http://www.cybersource.com/supportCopyright 2021. Cybersource Corporation. All rights reserved. Cybersource Corporation ("Cybersource") furnishes thisdocument and the software described in this document under the applicable agreement between the reader ofthis document ("You") and Cybersource ("Agreement"). You may use this document and/or software only inaccordance with the terms of the Agreement. Except as expressly set forth in the Agreement, the informationcontained in this document is subject to change without notice and therefore should not be interpreted in any wayas a guarantee or warranty by Cybersource. Cybersource assumes no responsibility or liability for any errors thatmay appear in this document. The copyrighted software that accompanies this document is licensed to You foruse 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 thisdocument in a retrieval system, or transmit this document, in any form or by any means, electronic, mechanical,recording, or otherwise, without the prior written consent of Cybersource.Restricted Rights LegendsFor Government or defense agencies: Use, duplication, or disclosure by the Government or defense agenciesis subject to restrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS252.227-7013 and in similar clauses 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 setforth in Cybersource Corporation's standard commercial agreement for this software. Unpublished rightsreserved under the copyright laws of the 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 theUnited States and other countries. All other trademarks, service marks, registered marks, or registered servicemarks are the property of their respective owners.Revision: 2021.012
CONTENTSContentsRecent Revisions to This DocumentAbout This Guide8Audience and Purpose8Conventions 8Note, Important, and Warning StatementsText and Command Conventions 9Related DocumentsCustomer SupportChapter 1IntroductionRecurring BillingSubscription ID78910111111Payment Network TokenSecure Acceptance1212Customer Subscriptions 12Installment Subscriptions 12Recurring Subscriptions 13On-Demand Customer Profile 13Supported Processors and Payment Methods13Relaxed Requirements for Address Data and Expiration DateTypes of Authorizations1717Authorization Consents 18Authorization for Electronic ChecksReporting 19Subscription Detail Report1819Transaction Endpoints 19Test Card Numbers 20Recurring Billing Using the Simple Order API 3
ContentsChapter 2Validating a SubscriptionCharging a Setup Fee2121Automatically Preauthorizing an AccountManually Preauthorizing a SubscriptionChapter 3Credit Card with a Setup FeePayment Network TokenEcheck252627Creating an Installment Subscription3132Creating a Recurring SubscriptionCredit Card3434Payment Network TokenEcheck3030Payment Network TokenEcheck2528Credit CardChapter 523Creating an On-Demand Customer ProfileCredit Card without a Setup FeeChapter 4213536Chapter 6Retrieving Subscription DetailsChapter 7Updating a Subscription3839Payment Card 39Updating Payment Card Account Number 39Removing Payment Card Expiration Date 40Payment Network Token 41Replacing Payment Card Information with a Payment Network TokenUpdating Payment Network Token Information 42Replacing a Payment Network Token with Payment Card InformationEcheck 44Updating an Echeck Account NumberChanging the Payment MethodUpdating Subscription Payments4143444445Recurring Billing Using the Simple Order API 4
ContentsChapter 8On-Demand Transactions46Requesting an On-Demand Transaction46Converting a Transaction to a Customer SubscriptionChapter 9Canceling or Deleting a SubscriptionCanceling a SubscriptionDeleting a SubscriptionChapter 105051Email Notifications 51Email Format 52Email Smart Tags 52Email Templates 53Successful Payment TemplateFailed Payment Template 53Merchant-Initiated TransactionsOptional Data Storage55Customer Subscription Sharing5658Numbered ElementsService Names59Request Fields60Reason Codes5657Data Type DefinitionsReply Fields5454Replacement Expiration DatesAppendix A API Fields5354Visa Bill Payment ProgramAccount Updater4949Additional FeaturesPayment Exceptions4758587887AVS and CVN Codes 90International AVS Codes 90U.S. Domestic AVS Codes 90CVN Codes 92Recurring Billing Using the Simple Order API 5
ContentsAppendix B Examples93Name-Value Pair Examples 93Creating a Customer Profile without a Setup Fee 93Creating a Customer Profile with a 5.00 Setup Fee 94Creating a Customer Subscription 95Installment: Credit Card without a Setup Fee 95Recurring: Credit Card with a 5.00 Setup Fee 96Updating a Customer Subscription 97Updating a Card Account Number 97Removing Card Expiration Dates 98Updating a Payment Event 98Updating an Echeck Account Number 99Retrieving a Customer Subscription 99Deleting a Customer Subscription 100Canceling a Customer Subscription 101XML Examples 102Creating a Customer Profile without a Setup Fee 102Creating a Customer Profile with a 5.00 Setup Fee 103Creating a Customer Subscription 105Installment: Credit Card without a Setup Fee 105Recurring: Credit Card with a 5.00 Setup Fee 106Updating a Customer Subscription 108Updating a Card Account Number 108Removing Card Expiration Dates 109Updating an Echeck Account Number 109Retrieving a Customer Subscription 110Deleting a Customer Subscription 111Canceling a Customer Subscription 112Recurring Billing Using the Simple Order API 6
ReleaseChanges2021.01Added maximum number of retries to "Payment Exceptions," page 54.2020.02Changed Cybersource through VisaNet to Visa Platform Connect.REVISIONSRecent Revisions to ThisDocumentRemoved support for PINless debit cards.Moneris: added support for China UnionPay. See "Supported Processorsand Payment Methods," page 13.2020.01Added endpoints and Business Center URLs for India.2019.04Updated Business Center procedures throughout.Added Chapter 3, "Creating an On-Demand Customer Profile," on page 25.Updated creating an installment customer profile with a payment networktoken. See "Payment Network Token," page 31.Updated creating a recurring customer profile with a payment networktoken. See"Payment Network Token," page 35.2019.03Added JCN Gateway as a supported processor. See "SupportedProcessors and Payment Methods," page 13.2019.02CCS (CAFIS): removed this processor from the documentation.Changed the name of Mastercard SecureCode to Mastercard IdentityCheck.Changed the name of Verified by Visa to Visa Secure.Recurring Billing Using the Simple Order API 7
ABOUT GUIDEAbout This GuideAudience and PurposeThis guide is written for merchants who want to create customer payment subscriptionsand eliminate payment data from their network to ensure that customers’ sensitivepersonal information is not compromised during a security breach. A customer’s sensitiveinformation is replaced with a unique identifier, known as a subscription ID, which youstore on your network.The purpose of this guide is to help you create, update, retrieve, and delete customersubscriptions. It also describes how to process an on-demand transaction using acustomer subscription and how to update a payment event.ConventionsNote, Important, and Warning StatementsA Note contains helpful suggestions or references to material not contained inthe document.An Important statement contains information essential to successfullycompleting a task or learning a concept.A Warning contains information or instructions, which, if not heeded, can resultin a security risk, irreversible loss of data, or significant cost in time or revenueor both.Recurring Billing Using the Simple Order API 8
About This GuideText and Command ConventionsConventionUsagebold Field and service names in text; for example:Include the billTo firstName field. Items that you are instructed to act upon; for example:Click Save.Screen text XML elements. Code examples and samples.Related DocumentsRefer to the Support Center for complete Cybersource technical documentation:http://www.cybersource.com/support center/support documentationTable 1Related DocumentsSubjectDescriptionAccount UpdaterAccount Updater User Guide (PDF HTML)—describes how toautomatically incorporate changes made to a customer’spayment card data.Authorizations with PaymentNetwork TokensAuthorizations with Payment Network Tokens Using the SimpleOrder API (PDF HTML)—describes how to requestauthorizations with payment network tokens.Business CenterBusiness Center User Guide (PDF HTML)—describes thefeatures and options available in the Business Center.Credit CardCredit Card Services Using the Simple Order API (PDF)—describes how to integrate credit card processing into your ordermanagement system.EcheckElectronic Check Services Using the Simple Order API (PDF HTML)—describes how to integrate echeck processing into yourorder management system.Offline TransactionSubmissionOffline Transaction File Submission Implementation Guide (PDF HTML).ReportingBusiness Center Reporting User Guide (PDF HTML)—describes the features and options available in the BusinessCenter.Recurring Billing Using the Simple Order API 9
About This GuideTable 1Related Documents (Continued)SubjectDescriptionSimple Order API Getting Started with Cybersource Advanced for the SimpleOrder API (PDF HTML)—describes how to get started usingthe Simple Order API. Simple Order API and SOAP Toolkit API Documentation andDownloads page. Simple Order API and SOAP Toolkit API Testing Informationpage.Customer SupportFor support information about any Cybersource service, visit the Support Center:http://www.cybersource.com/supportRecurring Billing Using the Simple Order API 10
CHAPTERIntroduction1Recurring BillingRecurring Billing protects sensitive cardholder information in order to comply with industrystandards and government regulations and can prevent the theft of payment cardinformation. The Recurring Billing solution is compatible with the Visa and MastercardAccount Updater service. All payment information stored with Cybersource isautomatically updated by participating banks, thereby reducing payment failures. See theAccount Updater User Guide (PDF HTML) for more information.Recurring Billing can be used only to collect scheduled payments from customers, not todisburse payments.Contact customer support to configure your account for Recurring Billing.Subscription IDA subscription ID, also known as a payment token, which you can store on your server, isa unique identifier that cannot be reverse-engineered. It replaces sensitive payment cardand billing information.Contact customer support to have your account configured for a 16-digitsubscription ID, or to update from a 22-digit subscription ID to a 16-digitsubscription ID.There are three types of subscription IDs: 22 digit—the default subscription ID. 16 digit—displays the final 4 digits of the primary account number (PAN) and passesLuhn mod-10 checks. This subscription ID is for payment card customersubscriptions. 16 digit—displays 99 as the two leading digits and passes Luhn mod-10 checks. Ifyour business rules prohibit using 99 as the leading digits, you must modify yoursystem to accept the other 16-digit subscription ID.Recurring Billing Using the Simple Order API 11
Chapter 1IntroductionPayment Network TokenThe payment network token replaces the primary account number (PAN) that is stored in acustomer subscription. You can create a customer subscription and include the paymentnetwork token (see "Payment Network Token," page 31), update the payment networktoken details (see "Updating Subscription Payments," page 45), and replace a paymentnetwork token with updated payment card details (see "Changing the Payment Method,"page 44).Secure AcceptanceIf you use Secure Acceptance to process transactions, the payment token is the customersubscription ID (see "Subscription ID," page 11). The payment token identifies thepayment card and retrieves the associated billing, shipping, and payment cardinformation.Customer SubscriptionsThere are two types of subscriptions: installment subscriptions and recurringsubscriptions. A customer subscription contains specific information about a customer thatyou store in the Cybersource database for future billing. You can also view the customersubscription in the Cybersource Business Center.A customer subscription includes but is not limited to: Billing and shipping information. Payment card type, masked account number, and expiration date. Transaction reference numbers and merchant-defined data fields.Installment SubscriptionsAn installment subscription enables you to charge a customer’s preferred paymentmethod on a fixed number of scheduled payments. You must specify the number ofpayments, the amount and frequency of each payment, and the start date for processingthe payments. Cybersource creates a schedule based on this information andautomatically bills the customer according to the schedule. For example, you can offer aproduct for 75.00 and let the customer pay in three installments of 25.00.See Chapter 4, "Creating an Installment Subscription," on page 30.Recurring Billing Using the Simple Order API 12
Chapter 1IntroductionRecurring SubscriptionsA recurring subscription allows you to charge a customer’s preferred payment method ona recurring payment basis with no specific end date. You must specify the amount andfrequency of each payment and the start date for processing the payments. Cybersourcecreates a schedule based on this information and automatically bills the customeraccording to the schedule. For example, you can offer an online service to which thecustomer subscribes and can charge a monthly fee.After you have created a customer subscription, you can: Update customer subscription information. Change the payment method of a customer subscription. Process an on-demand transaction using the customer subscription details. Update subscription payment events. Retrieve customer subscription information. Cancel a customer subscription. Delete a customer subscription. Share customer subscriptions (see "Customer Subscription Sharing," page 56).See Chapter 4, "Creating an Installment Subscription," on page 30.On-Demand Customer ProfileFor information about processing on-demand payments to create a customer profile, see"Creating an On-Demand Customer Profile," page 25.Supported Processors and PaymentMethodsEach customer subscription has an associated payment method: credit card, echeck, orother.The other payment method enables you to store data securely in a customer subscription.This payment method is useful if you do not intend to use the customer subscription forpayment transactions. See "Optional Data Storage," page 54.Recurring Billing Using the Simple Order API 13
Chapter 1IntroductionAll the processors listed in the table below support automaticpreauthorizations and manual preauthorizations. Unless stated otherwise, each processorin the table below supports 1.00 preauthorizations using all payment card types.Table 2Supported Processors and Payment MethodsProcessorPayment MethodAIBMSCredit card.American Express BrightonCredit card.Only American Express card types are supported.Does not support automatic preauthorization reversals.American Express DirectDebit card and prepaid card—supports partial authorizations.Only American Express card types are supported.Asia-Mideast ProcessingCredit card.BarclaysCredit card—supports 0.00 preauthorizations for Visa andMastercard cards.Chase Paymentech Solutions Credit card—supports 0.00 preauthorizations for Visa andMastercard cards. Debit card and prepaid card—supports partialauthorizations for Visa, Mastercard, American Express,Discover, and Diners Club cards. Electronic check. Replacement expiration dates are supported for Visa andMastercard. See "Replacement Expiration Dates," page 56. Visa Bill Payments—see "Visa Bill Payment Program,"page 55.CitibankCredit card—supports 0.00 preauthorizations for Visa andMastercard cards.Cybersource ACH ServiceElectronic check.Elavon AmericasCredit card—supports 0.00 preauthorizations for Visa,Mastercard, American Express, Discover, Diners Club, andChina UnionPay.FDC Compass Credit card—supports 0.00 preauthorizations for Visa andMastercard. Debit card and prepaid card—supports partialauthorizations for Visa, Mastercard, American Express, andDiscover. Replacement expiration dates are supported for Visa andMastercard. See "Replacement Expiration Dates," page 56. Visa Bill Payments—see "Visa Bill Payment Program,"page 55.Recurring Billing Using the Simple Order API 14
Chapter 1Table 2IntroductionSupported Processors and Payment Methods (Continued)ProcessorPayment MethodFDC Nashville Global Credit card—supports 0.00 preauthorizations for Visa,Mastercard, and China UnionPay. Debit card and prepaid card—supports partialauthorizations for Visa, Mastercard, American Express,Discover, Diners Club, JCB (US Domestic), and ChinaUnionPay. Visa Bill Payments—see "Visa Bill Payment Program,"page 55. Credit card—supports 0.00 preauthorizations for Visa cards. Debit card and prepaid card—supports partialauthorizations for Visa, Mastercard, American Express,Discover, Diners Club, and JCB (US Domestic). Visa Bill Payments—see "Visa Bill Payment Program,"page 55. Credit card—supports 0.00 preauthorizations for Visa andMastercard. Debit card and prepaid card—supports partialauthorizations for Visa, Mastercard, American Express,Discover, and JCB (US Domestic). Replacement expiration dates are supported for Visa andMastercard. See "Replacement Expiration Dates," page 56. Credit card—supports 0.00 preauthorizations for Visa andMastercard. Debit card and prepaid card—supports partialauthorizations for Visa, Mastercard, American Express,Discover, Diners Club, and JCB. Visa Bill Payments—see "Replacement Expiration Dates,"page 56.FDMS NashvilleFDMS SouthGPNHSBCCredit card—supports 0.00 preauthorizations for Visa andMastercard.Important Does not support automatic preauthorizationreversals.Ingenico ePaymentsCredit card.JCN GatewayCredit card.LloydsTSB CardnetCredit card.MonerisCredit card—supports 0.00 preauthorizations for Visa,Mastercard, and China UnionPay.OmniPay DirectCredit card—supports 0.00 preauthorizations using Visa,Mastercard, Maestro (International), and Maestro (UKDomestic).Recurring Billing Using the Simple Order API 15
Chapter 1Table 2IntroductionSupported Processors and Payment Methods (Continued)ProcessorPayment MethodOmniPay-Ireland Credit card—supports 0.00 preauthorizations using Visaand Mastercard. Visa Bill Payments—see "Visa Bill Payment Program,"page 55. Credit card—supports 0.00 preauthorizations for Visa andMastercard. Electronic check.RBS WorldPay AtlantaSIXCredit card.StreamlineCredit card—supports 0.00 preauthorizations for Visa andMastercard.TeleChe
Reason Codes 87 AVS and CVN Codes 90 International AVS Codes 90 U.S. Domestic AVS Codes 90 CVN Codes 92. Recurring Billing Using the Simple Order API 6 Contents . 2020.02 Changed Cybersource through VisaNet to Visa Platform Connect. Removed support for PINless debit cards. Moneris: ad
