Title Page

Credit Card Services

Using the Simple Order API

September 2019

CyberSource Corporation HQ | P.O. Box 8999 | San Francisco, CA 94128-8999 | Phone: 800-530-9095
CyberSource Contact Information
For general information about our company, products, and services, go to
http://www.cybersource.com.

For sales questions about any CyberSource Service, email [email protected] or

call 650-432-7350 or 888-330-2300 (toll free in the United States).

For support information about any CyberSource Service, visit the Support Center at
http://www.cybersource.com/support.

Copyright
© 2019 CyberSource Corporation. All rights reserved. CyberSource Corporation ("CyberSource") furnishes this
document and the software described in this document under the applicable agreement between the reader of
this document ("You") and CyberSource ("Agreement"). You may use this document and/or software only in
accordance with the terms of the Agreement. Except as expressly set forth in the Agreement, the information
contained in this document is subject to change without notice and therefore should not be interpreted in any way
as a guarantee or warranty by CyberSource. CyberSource assumes no responsibility or liability for any errors
that may appear in this document. The copyrighted software that accompanies this document is licensed to You
for use only in strict accordance with the Agreement. You should read the Agreement carefully before using the
software. Except as permitted by the Agreement, You may not reproduce any part of this document, store this
document 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 Legends

For Government or defense agencies. Use, duplication, or disclosure by the Government or defense agencies
is subject to restrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS
252.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 set
forth in CyberSource Corporation's standard commercial agreement for this software. Unpublished rights
reserved under the copyright laws of the United States.

Trademarks
Authorize.Net, eCheck.Net, and The Power of Payment are registered trademarks of CyberSource Corporation.
CyberSource, CyberSource Payment Manager, CyberSource Risk Manager, CyberSource Decision Manager,
and CyberSource Connect are trademarks and/or service marks of CyberSource Corporation.
All other brands and product names are trademarks or registered trademarks of their respective owners.

2
 CONTENTS
Contents

Recent Revisions to This Document 13

About This Guide 19

Audience and Purpose 19
Conventions 19
Related Documentation 20
Customer Support 20

Chapter 1 Introduction to the Credit Card Services 21

Cards and Payment Methods 21
Cartes Bancaires Cards 21
Debit Cards 22
Discover Acquisitions and Alliances 23
mada Debit Cards 24
Mastercard 2-Series Bank Identification Numbers 25
Types of Transactions 26
Card-Present Transactions 26
Card-Not-Present Transactions 26
Transactions with Special Data 26
International Transactions 27
Compliance 27
Merchant Remittance Funding 27
Banks and Associations 28
Acquiring (Merchant) Banks 28
Issuing (Consumer) Banks 29
Payment Card Companies 29
Services 30
Order Tracking 30
Request IDs 30
Reconciliation IDs 31
Payment Processors 32

Credit Card Services Using the Simple Order API | September 2019 3
 Contents

Chapter 2 Payment Card Processing 38

Authorizing a Payment 38
Online Authorizations 38
Offline Authorizations 40
Automatic Captures 40
Creating an Authorization Request 41
Checking the Status of an Authorization Request 44
Incremental Authorizations 45
Limitations 45
Incremental Authorization Scenario 45
Supported Features 46
Performing an Incremental Authorization 47
Authorization Information for Specific Processors 48
Reversing an Authorization 52
Supported Processors and Card Types 53
Creating a Full Authorization Reversal Request 57
Authorization Reversals for Single-Message Processing 59
Authorization Reversal after Void (ARAV) 59
Automatic ARAV 60
Capturing an Authorization 61
Captures 61
Creating a Capture Request 62
Capture Information for Specific Processors 64
Capture Features 68
Authorization Refresh 68
Automatic Partial Authorization Reversals 69
Interchange Optimization 70
Multiple Partial Captures 71
Performing a Sale 75
Dual-Message Processing 75
Single-Message Processing 76
Partial Authorizations 76
Supported Features on CyberSource through VisaNet 77
Supported Features on RuPay 77
Unsupported Features 78
Crediting a Payment 78
Types of Credits 79
Creating a Credit Request 79
Credit Information for Specific Processors 82
Credit Authorizations 84
Voiding a Capture or Credit 85
Capture after Void 86
Creating a Void Request 86

Credit Card Services Using the Simple Order API | September 2019 4
 Contents

Chapter 3 Authorization Features 88

Address Verification System (AVS) 88
Standard AVS 88
Relaxed Requirements for Address Data and Expiration Date 91
Processing AVS Codes 92
Controlling AVS Results 92
Enhanced AVS 93
Automated Address Verification Plus (AAV+) 93
Electronic Verification (EV) 94
Request Fields 95
Reply Fields 96
Card Verification Numbers (CVNs) 97
CVN Locations and Terminology 100
CVN Codes 100
Verbal Authorizations 101

Chapter 4 Features for Debit Cards and Prepaid Cards 105

Partial Authorizations 105
Supported Processors and Card Types 106
Opting In 107
Opting Out 107
How a Partial Authorization Works 107
Special Processing for American Express Cards on Chase Paymentech
Solutions 109
Special Processing for IDR and CLP on FDMS South 109
Real-Time Reversals 110
Balance Responses 111
Features for Maestro (UK Domestic) Cards 115
Unsupported Processors and Card Types 115

Chapter 5 Optional Features 116

0 Authorizations 116
Additional Amounts 116
Shipping and Handling Fees 117
Taxes 117

Credit Card Services Using the Simple Order API | September 2019 5
 Contents

Aggregator Support 117

Terminology 118
American Express Direct Aggregators 118
CyberSource through VisaNet Aggregators 121
Aggregator Transactions with American Express 121
Aggregator Transactions with Mastercard 122
Aggregator Transactions with Any Other Card Type 123
FDC Compass Aggregators 124
FDC Nashville Global Aggregators 125
Airline Data 126
American Express SafeKey 126
Android Pay 126
Apple Pay 126
Authorization Only 127
AVS Only 127
Balance Inquiries 128
Bill Payments with Mastercard 128
Bill Payments with Visa 128
BNDES 129
Card-on-File Transactions 130
Card-Present Data 130
Card Type Indicators (CTIs) 130
Cash Advances 132
Chase Pay 132
Credentials-on-File Transactions 132
Customer Profiles 132
Dynamic Currency Conversion with a Third Party Provider 133
Requirement and Limitations 133
Terminology 134
Examples 134
Authorizing a Payment 135
Reversing an Authorization 136
Capturing an Authorization 136
Crediting the Payment 137
Encoded Account Numbers 137
Final Authorization Indicator 138
Final Authorizations 139
Preauthorizations 140
Undefined Authorizations 140
Unmarked Authorizations 141
Forced Captures 142
Full-Financial Transactions 144

Credit Card Services Using the Simple Order API | September 2019 6
 Contents

Google Pay 144

Guaranteed Exchange Rates 144
Installment Payments 145
Installment Payments on American Express Direct 148
Installment Payments on Chase Paymentech Solutions and FDC Compass 150
Installment Payments on CyberSource through VisaNet 150
Overview 150
Installment Payments on CyberSource through VisaNet in Brazil 152
Installment Payments on CyberSource through VisaNet in Croatia 155
Installment Payments on CyberSource through VisaNet in Georgia
(Sakartvelo) 155
Installment Payments on CyberSource through VisaNet in Greece 156
Installment Payments on CyberSource through VisaNet in Other Countries 157
Installment Payments on FDC Nashville Global 158
Installment Payments on FDI Australia 159
Installment Payments on Processors in Latin America 159
Installment Payments on Other Processors 161
Japanese Payment Options 162
Additional Japanese Payment Option Fields 163
Verbal Authorizations 163
Stand-Alone Credits 163
Additional Information 164
JCB J/Secure 164
Least-Cost Routing (LCR) 164
Partial Authorizations 166
Supported Features 166
Unsupported Features 167
Level II Data 167
Level III Data 167
Mastercard Bill Payments 167
Mastercard Expert Monitoring Solutions (EMS) 168
Mastercard Identity Check 168
Mastercard Send 168
Masterpass 169
Merchant Descriptors 169
Merchant-Initiated Reversals and Voids 170

Credit Card Services Using the Simple Order API | September 2019 7
 Contents

Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF) Transactions 173

Overview 176
Obtaining a Customer’s Credentials 176
Cardholder-Initiated Transactions with Credentials on File 177
Merchant-Initiated Transactions 178
Industry Practice MITs 178
Standing Instruction MITs 182
API Field Descriptions 185
Micropayments 185
Multi-Currency Service 185
Network Tokenization 186
Partial Shipments 186
Payer Authentication 186
American Express SafeKey 187
JCB J/Secure 188
Mastercard Identity Check 189
ProtectBuy 195
RuPay PaySecure 196
Visa Secure 197
Payment Network Tokenization 204
Payment Tokenization 204
Payouts 204
POS Transactions 204
Quasi-Cash 205
Recipients 206
Recurring Billing 207
Recurring Payments 207
AVS and Recurring Payments 214
CVN and Recurring Payments 214
Replacement Expiration Dates for Recurring Payments 215
Recurring Profiles 216
Report Groups 217
Retail POS Data 218
Samsung Pay 218
Secure Data 218
Service Fees 219
Single-Message Processing 219
Soft Descriptors 219
Split Dial/Route 219

Credit Card Services Using the Simple Order API | September 2019 8
 Contents

Split Shipments 220

Benefits of Using Split Shipments 220
Requirements 221
How Split Shipments Work 221
Additional Authorizations 221
Additional Captures 221
Split-Shipment Scenarios 222
One Authorization and One Sale 222
One Authorization and Two Captures 223
Multiple Captures in a Batch File 223
Two Authorizations and One Capture 224
Obtaining the Status of a System-Generated Authorization 225
Additional Information 226
Staged Digital Wallets 226
Terminology 226
Requirements 227
SDW Functionality 227
Subscriptions 227
Tax Calculation 227
Tokenization 227
Token Management Service (TMS) 228
Type II Cards 228
Verbal Authorizations 228
Visa Bill Payments 229
Visa Checkout and Visa Secure Remote Commerce 229
Visa Debt Repayments 230
Visa Direct 230
Visa Secure 230
Zero Amount Authorizations 231

Chapter 6 Testing the Credit Card Services 237

Requirements for Testing 237
Testing the Services 238
Using Amounts to Simulate Errors 239
Testing American Express Card Verification 239

Credit Card Services Using the Simple Order API | September 2019 9
 Contents

Appendix A API Fields 240

Formatting Restrictions 240
Multibyte Characters 240
Data Type Definitions 241
Numbered Elements 242
Request Fields 243
Reply Fields 362

Appendix B Examples 403

Name-Value Pair Examples 403
Basic Credit Card Examples 403
Asia, Middle East, and Africa Gateway Examples 406
Cielo Examples 407
CyberSource Latin American Processing Examples 410
Incremental Authorization Examples 411
Partial Authorization Examples 412
Fully Approved Request 412
Partially Approved Request 414
RuPay Examples 416
Split-Shipment Examples 417
One Authorization and One Sale 417
One Authorization and Two Captures 420
Two Authorizations and One Capture 422
Visa Checkout and Visa Secure Remote Commerce Examples 424
Worldpay VAP Examples 426
XML Examples 428
Basic Credit Card Examples 428
Asia, Middle East, and Africa Gateway Examples 431
Cielo Examples 433
CyberSource Latin American Processing Examples 438
Incremental Authorization Examples 440
Partial Authorization Examples 441
Fully Approved Request 441
Partially Approved Request 443
RuPay Examples 445
Split-Shipment Examples 447
One Authorization and One Sale 447
One Authorization and Two Captures 451
Two Authorizations and One Capture 454
Visa Checkout and Visa Secure Remote Commerce Examples 458
Worldpay VAP Examples 460

Credit Card Services Using the Simple Order API | September 2019 10
 Contents

Appendix C Additional Amount Types 462

Appendix D American Express SafeKey Response Codes 467

Appendix E AVS Codes 468

AVS Codes for Cielo 3.0 and CyberSource Latin American Processing 468
AVS Codes for All Other Processors 469

Appendix F Business Application Identifiers 472

Appendix G Card Types 473

Appendix H Chargeback Reason Codes 475

Chargeback Reason Codes for Visa 475
Chargeback Reason Codes for Mastercard 476

Appendix I Commerce Indicators 477

Appendix J CVN Codes 479

Appendix K CyberSource through VisaNet Acquirers 480

Appendix L Expert Monitoring Solutions (EMS) Reason Codes 484

Appendix M Electronic Verification Response Codes 486

Appendix N Formats for Discretionary Data 487

Example for Visa Guatemala 487
Example for VisaNet Uruguay 488

Credit Card Services Using the Simple Order API | September 2019 11
 Contents

Appendix O Frequently Asked Questions 489

Appendix P Ingenico ePayments Credit Card Reversals 492

Requests for Information 492
Chargebacks 493
Representments 494
Request for Information Example 496

Appendix Q Network Transaction Identifiers 498

CyberSource through VisaNet 498
GPN 498

Appendix R Product Codes 500

Appendix S Product IDs 501

Mastercard Product IDs 501

Appendix T Visa Secure Response Codes 505

Appendix U Values for the Wallet Type Field 506

Index 507

Credit Card Services Using the Simple Order API | September 2019 12
 REVISIONS
Recent Revisions to This
Document

Release Changes
September 2019 All processors: fixed the broken links to Reason Codes.
All processors that support merchant-initiated transactions (MITs):
 Updated "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173:
 Added support for customer-initiated transactions with credentials on file.

 Updated information about required fields for the MIT scenarios.

 Updated descriptions for the following fields in "Request Fields," page 243:
 subsequentAuth

 subsequentAuthOriginalAmount
 subsequentAuthReason
All processors that support Visa Checkout:
 Changed “Visa Checkout” to “Visa Checkout and Visa Secure Remote Commerce”
throughout the guide.
 Replaced links to Visa Checkout documentation with link to web page that provides the Visa
Checkout and Visa Secure Remote Commerce documentation: Visa Checkout and Visa
Secure Remote Commerce web page.
Chase Paymentech Solutions: ccCreditService_commerceIndicator is required for stand-
alone credit requests. See "Creating a Credit Request," page 79.
CyberSource through VisaNet: added Visa to the TC 33 mapping information for the
invoiceHeader_submerchantID field in "Request Fields," page 243.
FDC Nashville Global: added support for Mastercard Identity Check 2.0. See "Mastercard
Identity Check," page 189.

Credit Card Services Using the Simple Order API | September 2019 13
 Recent Revisions to This Document

Release Changes
August 2019 All processors: moved reason codes for the Simple Order API to Reason Codes.
All processors that support merchant-initiated transactions: updated the note at the beginning
of the section by adding a link to a new FAQ. See "Merchant-Initiated Transactions (MITs) and
Credentials-on-File (COF) Transactions," page 173.
CyberSource through VisaNet: updated the TC 33 field names for the following fields. See
"Request Fields," page 243.
 ccAuthService_aggregatorID
 invoiceHeader_salesOrganizationID
 invoiceHeader_submerchantID
FDI Australia
 Added support for "Installment Payments," page 145.
 Added support for "Least-Cost Routing (LCR)," page 164.
 Added support for "Zero Amount Authorizations," page 231.
All processors that support merchant-initiated transactions: updated the description for
subsequentAuthStoredCredential. See "Request Fields," page 243.
Barclays: added support for "Merchant-Initiated Transactions (MITs) and Credentials-on-File
(COF) Transactions," page 173.
CyberSource through VisaNet: updated the information about installment payments with
Mastercard:
 In the feature description:
 Updated the description for Mastercard in Brazil. See "Installment Payments on
CyberSource through VisaNet in Brazil," page 152.
 Added "Installment Payments on CyberSource through VisaNet in Croatia," page 155.
 Added "Installment Payments on CyberSource through VisaNet in Georgia (Sakartvelo),"
page 155.
 Added "Installment Payments on CyberSource through VisaNet in Greece," page 156.
 Added section for Mastercard in "Installment Payments on CyberSource through VisaNet
in Other Countries," page 157.

Credit Card Services Using the Simple Order API | September 2019 14
 Recent Revisions to This Document

Release Changes
July 2019  In "Request Fields," page 243:
 Added installment_firstInstallmentAmount.

 Updated descriptions for these fields:

 billTo_merchantTaxID  installment_monthlyInterestRate

 installment_amount  installment_paymentType

 installment_gracePeriodDuration  installment_planType

 installment_  installment_totalCount
gracePeriodDurationType

 In "Reply Fields," page 362:

 Added these new fields:

 installment_amount  installment_totalAmount

 installment_firstInstallmentDate  installment_totalCount

 Updated descriptions for these fields:

 installment_additionalCosts  installment_firstInstallmentAmount

 installment_  installment_insurance
additionalCostsPercentage

 installment_amountFunded  installment_insurancePercentage

 installment_  installment_maximumTotalCount
amountRequestedPercentage
 installment_annualInterestRate  installment_minimumTotalCount

 installment_expenses  installment_monthlyInterestRate

 installment_expensesPercentage  installment_taxes

 installment_fees  installment_taxesPercentage

 installment_feesPercentage

Elavon Americas: recurring payments with Visa must comply with the Visa merchant-initiated
transactions mandate. See "Recurring Payments," page 207.
HBoS: added support for "Merchant-Initiated Transactions (MITs) and Credentials-on-File
(COF) Transactions," page 173.
HSBC: added support for "Merchant-Initiated Transactions (MITs) and Credentials-on-File
(COF) Transactions," page 173.
Lloyds-OmniPay: added support for "Merchant-Initiated Transactions (MITs) and Credentials-
on-File (COF) Transactions," page 173.
SIX: added support for "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.
Streamline: added support for "Merchant-Initiated Transactions (MITs) and Credentials-on-File
(COF) Transactions," page 173.

Credit Card Services Using the Simple Order API | September 2019 15
 Recent Revisions to This Document

Release Changes
June 2019 All processors that support Mastercard SecureCode: changed the name of this feature to
Mastercard Identity Check.
All processors that support Verified by Visa: changed the name of this feature to Visa Secure.
CCS (CAFIS): removed this processor from the documentation.
Chase Paymentech Solutions: added support for Discover for "Zero Amount Authorizations,"
page 231.
CyberSource through VisaNet:
 Added support for "Japanese Payment Options," page 162.
 Added support for the following payer authentication fields. See "Mastercard Identity
Check," page 189.
 ccAuthService_directoryServerTransactionID

 ccAuthService_paSpecificationVersion
 Added support for the Sumitomo Mitsui Card Co. acquirer. See Appendix K, "CyberSource
through VisaNet Acquirers," on page 480.
JCN Gateway:
 Updated "Japanese Payment Options," page 162.
 Removed the NICOS and ORICO cards.
OmniPay Direct: added support for the following payer authentication fields. See "Mastercard
Identity Check," page 189.
 ccAuthService_directoryServerTransactionID
 ccAuthService_paSpecificationVersion

Credit Card Services Using the Simple Order API | September 2019 16
 Recent Revisions to This Document

Release Changes
April 2019 Added new processor Getnet. See "Payment Processors," page 32, and Chapter 2, "Payment
Card Processing," on page 38.
Added new processor Software Express. See "Payment Processors," page 32, and Chapter 2,
"Payment Card Processing," on page 38.
American Express Direct: added values to Table 57, "Additional Amount Types for Goods and
Services," on page 462.
Chase Paymentech Solutions: added support for American Express for "Zero Amount
Authorizations," page 231.
CyberSource through VisaNet:
 Added enhancements for Mastercard installment payments in Brazil:
 Added two funding methods: co-branded merchant financed and issuer merchant co-
financed. See "Overview," page 150.
 Added two values for the installment_planType field for the new funding methods. See
"Request Fields," page 243.
 Added two request fields for grace periods. See the installment_gracePeriodDuration
and installment_gracePeriodDurationType fields in "Request Fields," page 243.
 Added three reply fields. See the installment_firstInstallmentAmount, installment_
minimumTotalCount, and installment_maximumTotalCount fields in "Reply Fields,"
page 362.
 Added the following request fields. For details, see "Request Fields," page 243.
 ccAuthService_cryptocurrencyPurchase

 ccAuthService_deferredAuthIndicator
 ccAuthService_lowValueExemptionIndicator
 ccAuthService_riskAnalysisExemptionIndicator
 ccAuthService_secureCorporatePaymentIndicator
 ccAuthService_trustedMerchantExemptionIndicator
 ccAuthService_verificationType
Elavon Americas:
 Added support for "Masterpass," page 169.
 Updated the maximum length for the merchantReferenceCode field. See "Request Fields,"
page 243.

Credit Card Services Using the Simple Order API | September 2019 17
 Recent Revisions to This Document

Release Changes
March 2019 Added new processor RuPay. See "Payment Processors," page 32, and Chapter 2, "Payment
Card Processing," on page 38.
All processors that support merchant descriptors: moved the merchant descriptor information
to Merchant Descriptors Using the Simple Order API.
Chase Paymentech Solutions: added American Express as a supported card type for full
authorization reversals. See "Reversing an Authorization," page 52.
Credit Mutuel-CIC: updated the description for cardTypeSelectionIndicator to indicate that
the field is required for the authorization service. See "Request Fields," page 243.
CyberSource through VisaNet: added American Express as a supported card type for Network
International. See Appendix K, "CyberSource through VisaNet Acquirers," on page 480.
Ingenico ePayments: added note stating that CyberSource does not support Diners Club or
Discover on Ingenico ePayments. See Table 10, "Payment Processors and Card Types," on
page 33.

Credit Card Services Using the Simple Order API | September 2019 18
 ABOUT GUIDE
About This Guide

Audience and Purpose

This guide is written for application developers who want to use the CyberSource Simple
Order API to integrate payment card processing into their order management system.

Implementing the CyberSource credit card services requires software development skills.
You must write code that uses the API request and reply fields to integrate the credit card
services into your existing order management system.

Conventions
The following special statements are used in this document:

A Note contains helpful suggestions or references to material not contained in

this document.
Note

An Important statement contains information essential to successfully

completing a task or learning a concept.
Important

A Warning contains information or instructions, which, if not heeded, can result

in a security risk, irreversible loss of data, or significant cost in time or revenue
Warning or both.

Credit Card Services Using the Simple Order API | September 2019 19
 About This Guide

The following text conventions are used in this document:

Table 1 Text Conventions

Convention Meaning
bold Field and service names in text; for example:
Include the ccAuthService_run field.
screen text  XML elements
 Code examples
 Values for API fields; for example:
Set the ccAuthService_run field to true.

Related Documentation
 Getting Started with CyberSource Advanced for the Simple Order API describes how
to get started using the Simple Order API. (PDF | HTML)

 The Classic Reporting Developer Guide describes how to download reports.

(PDF | HTML)

 The Secure Acceptance Checkout API Integration Guide describes how to create a
Secure Acceptance Checkout API profile. (PDF | HTML)

 The Secure Acceptance Hosted Checkout Integration Guide describes how to create
a Secure Acceptance Hosted Checkout profile. (PDF | HTML)

 The CyberSource API Versions page provides information about the CyberSource API
versions.

Refer to the Support Center for complete CyberSource technical documentation:

http://www.cybersource.com/support_center/support_documentation

Customer Support
For support information about any CyberSource service, visit the Support Center:
http://www.cybersource.com/support

Credit Card Services Using the Simple Order API | September 2019 20
 CHAPTER
Introduction to the
Credit Card Services
1

Cards and Payment Methods

The credit card services can be used to process the types of cards and payment methods
described in the following table.

Table 2 Cards and Payment Methods Processed with Credit Card Services

Card or Description
Payment
Method
Credit cards CyberSource can accept payments made with numerous types of credit
cards, including Visa®, Mastercard®, American Express®, Discover®,
Diners Club®, and JCB®.
Private label cards Private label cards are payment cards that are issued by a private
company and that can be used only at the issuing company’s stores. If you
are interested in using CyberSource to process transactions for your
company’s private label card, contact your CyberSource account
representative for information.
Debit cards and Prepaid cards, Visa-branded debit cards, and Mastercard-branded debit
prepaid cards cards can be processed with the credit card services. See Chapter 4,
"Features for Debit Cards and Prepaid Cards," on page 105.
Quasi-cash A quasi-cash transaction is a cash-like transaction for the sale of items
that are directly convertible to cash. See "Quasi-Cash," page 205.

Cartes Bancaires Cards

Processor:
 Credit Mutuel-CIC

CyberSource supports the following kinds of Cartes Bancaires co-badged cards:

 Visa and Cartes Bancaires
 Mastercard and Cartes Bancaires

Credit Card Services Using the Simple Order API | September 2019 21
 Chapter 1 Introduction to the Credit Card Services

A co-badged card is not the same as a co-branded card:

 A co-badged card supports two or more card types, such as Visa and
Note Cartes Bancaires.
 A co-branded card is sponsored by an issuing bank and a retail merchant.

Cartes Bancaires co-badged cards are processed as follows:

 CyberSource can use the card’s BIN value to determine whether the card is a
co-badged Cartes Bancaires card.

 You must let the customer choose the card type to use for the transaction. You can
specify a default card type to use when the customer does not choose a card type or
when the customer chooses a card type that is not supported by the card.

 You can include the cardTypeSelectionIndicator field in the authorization request.

For more information, contact CyberSource Customer Support.

Debit Cards
The following table provides an overview of the CyberSource services that you can use for
processing debit cards.
Table 3 CyberSource Services for Processing Debit Cards

Services Description
Credit card You can use credit card services to process payments with prepaid cards,
services Visa-branded debit cards, and Mastercard-branded debit cards. See
Chapter 4, "Features for Debit Cards and Prepaid Cards," on page 105.
PIN debit services You can use PIN debit services to process payments if your processor
supports PIN debit transactions. See PIN Debit Processing Using the
Simple Order API.
PINless debit You can use PINless debit services to process payments if your business
services is in one of the acceptable merchant categories in which a card-not-
present debit transaction is low risk. These categories include educational
institutions, insurers, and utilities. See PINless Debit Card Services Using
the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 22
 Chapter 1 Introduction to the Credit Card Services

Discover Acquisitions and Alliances

Discover has acquired or entered into alliances with the payment card companies shown
in the following table.

Table 4 Discover Acquisitions and Alliances

Card Type Description

China UnionPay In 2005, China UnionPay and Discover announced a strategic alliance
Alliance whereby China UnionPay cards would be routed to the Discover Network.
As a result of this alliance:
 If you have been accepting Discover but not China UnionPay, you are
now able to accept and process China UnionPay cards that have been
reissued with Discover bank identification numbers (BINs).
 If you have been accepting China UnionPay but not Discover, you are
now able to accept Discover cards.
Diners Club In July 2008, Discover acquired Diners Club International whereby Diners
Acquisition Club cards would be routed to the Discover Network starting October 16,
2009. As a result of this acquisition:
 If you have been accepting Discover but not Diners Club, you are now
able to accept Diners Club cards.
 If you have been accepting Diners Club but not Discover, you are now
able to accept Discover cards.
JCB (US Domestic) In December 2006, JCB and Discover announced a strategic alliance
Alliance whereby JCB cards would be routed to the Discover Network in the U.S.
and select U.S. Territories (Puerto Rico, Guam, U.S. Virgin Islands,
Northern Mariana Islands) that authorize, process, and fund in USD. As a
result of this alliance:
 If you have been accepting Discover but not JCB, you are now able to
accept JCB cards.
 If you have been accepting JCB but not Discover, you are now able to
accept Discover cards.

For some card types on some processors, the information in your CyberSource account
must include processor-issued IDs for these transactions to be processed successfully.
Call CyberSource Customer Support to update your account information.

Credit Card Services Using the Simple Order API | September 2019 23
 Chapter 1 Introduction to the Credit Card Services

As a result of these acquisitions and alliances, the 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., Puerto Rico, Guam, U.S. Virgin Islands, or Northern
Mariana Islands.

Non-U.S. JCB transactions are still routed through JCB.

Note

Your processor takes care of routing your transactions; you do not need to do
any additional processing to route these card types to the Discover Network.
Note

mada Debit Cards

Processor:
 CyberSource through VisaNet—National Commercial Bank (NCB) is the only acquirer
that supports mada.

CyberSource supports the following kinds of mada co-badged debit cards:

 Visa and mada
 Mastercard and mada

A co-badged card is not the same as a co-branded card:

 A co-badged card supports two or more card types, such as Visa and
Note mada.
 A co-branded card is sponsored by an issuing bank and a retail merchant.

mada co-badged debit cards are processed as follows:

 Only domestic processing in Saudi Arabia is supported.

 CyberSource sends the transactions directly to the Saudi Arabia Monetary Authority
(SAMA) for processing.

 Payer authentication is supported. Visa Secure is supported for co-badged Visa-mada

cards. Mastercard Identity Check is supported for co-badged Mastercard-mada cards.
For more information, see "Payer Authentication," page 186.

Credit Card Services Using the Simple Order API | September 2019 24
 Chapter 1 Introduction to the Credit Card Services

 For acquirers, the card type is identified as MD.

 In reports, the card type is identified as either Visa or Mastercard.

 Dual-message processing is not supported. Only single-message processing is

supported. See "Single-Message Processing," page 76.

There are important differences between single-message processing and

dual-message processing:
Important  With single-message processing, an authorization+capture request
results in a full-financial transaction, which moves funds immediately.

 With single-message processing, the capture amount and

authorization amount are the same.

 Several services and features are not supported for single-message

processing because they are not applicable or could create
reconciliation problems. See "Unsupported Features," page 78.

Table 5 provides additional details about co-badged mada debit cards.

Table 5 Card Types for mada Cards

Card Types Supported Card Type Identified in the Notes

by the Card Transaction Request
Visa Visa CyberSource uses the BIN
mada value to determine whether
mada restrictions apply to the
transaction.
Mastercard Mastercard CyberSource uses the BIN
mada value to determine whether
mada restrictions apply to the
transaction.

Mastercard 2-Series Bank Identification Numbers

Mastercard expanded the BIN range by introducing BINs in the 222100-272099 range.
Cards containing the 2-series BINs were issued in 2017.

Effective October 2016, Mastercard requires processors, acquirers, issuers, and

merchants to support the 2-series BINs. Mastercard transactions on the 2-series primary
account numbers (PANs) must be accepted, routed, and processed, and they must
operate with the same rules that apply to the existing 5-series BINs.

Credit Card Services Using the Simple Order API | September 2019 25
 Chapter 1 Introduction to the Credit Card Services

Types of Transactions

Card-Present Transactions
When a customer uses a card that is physically present to make a purchase, the purchase
is known as a card-present transaction. This type of transaction typically occurs in a retail
environment. To process card-present transactions:
 Use the credit card services described in this guide.
 Provide card-present data as described in Card-Present Processing Using the Simple
Order API.

Card-Not-Present Transactions
When a customer provides a card number but you do not have access to the physical
card, the purchase is known as a card-not-present transaction. This type of transaction
typically occurs over the Internet or through a call center. To process card-not-present
transactions, use the credit card services described in this guide.

Card-not-present transactions pose an additional level of risk to your business because

you cannot directly verify the customer’s identification. CyberSource offers features, such
as Address Verification System (AVS) and Card Verification Numbers (CVN), in the credit
card services that can reduce that risk by checking the validity of the customer’s
information and notifying you when discrepancies occur. For descriptions of AVS and
CVN, see Chapter 3, "Authorization Features," on page 88.

Transactions with Special Data

The credit card services can process these types of special data:

 Airline data: see Airline Processing Using the Simple Order API.

 Level II and Level III data: see Level II and Level III Processing Using the Simple
Order API.

 Card-present data: see Card-Present Processing Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 26
 Chapter 1 Introduction to the Credit Card Services

International Transactions

Compliance
Accepting payments from a country other than your own requires that you observe the
processing rules and practices of the payment systems in that country. The following table
describes areas of compliance that have particular focus.

Table 6 Compliance for International Transactions

Area of Compliance Description

Merchant account descriptor The merchant account descriptor is a fixed text field that is
requirements associated with a payment card account. The purpose of the
descriptor is to communicate merchant information to customers
to remind them of the circumstances that triggered the payment.
Merchant descriptors reduce the possibility of a chargeback.
Accordingly, the merchant descriptor displayed on the
customer’s statement should be a close match to the name on
your web site. It is not good practice to consolidate multiple web
sites into a single payment card account and use a generic
descriptor that more-or-less covers all offerings. For details
about merchant descriptors, see "Merchant Descriptors,"
page 169.
Excessive chargebacks You are responsible for maintaining good customer support,
rapid problem resolution, a high level of customer satisfaction,
and transaction management processes that minimize
fraudulent transactions. All of these are required to prevent an
excessive number of chargebacks. In the event that credit card
chargebacks become excessive, CyberSource can require you
to undertake business process changes to reduce chargebacks.
If the chargebacks are not reduced to a satisfactory level,
CyberSource can terminate the account.
If Ingenico ePayments is your processor, see Appendix P,
"Ingenico ePayments Credit Card Reversals," on page 492 for
more information about chargebacks.
Note Ingenico ePayments was previously called Global
Collect.

Merchant Remittance Funding

In conjunction with processing international transactions, you can request that
CyberSource convert transaction proceeds to a currency other than the currency in which
the transaction took place for funding into an operating account. Currency conversion
uses a foreign exchange rate to calculate how much the transaction currency is worth in
terms of the funding currency. The foreign exchange rate might be explicitly stated as a
rate or implicitly stated as a transaction amount, and a funded amount and can vary from
day to day. The foreign exchange rate might also include a mark-up for the foreign
exchange risk, sales commissions, and handling costs.

Credit Card Services Using the Simple Order API | September 2019 27
 Chapter 1 Introduction to the Credit Card Services

Banks and Associations

In this document, the word processor can refer to a processor, acquirer, or

acquiring processor depending on your location.
Note

Acquiring (Merchant) Banks

An acquiring, or merchant, bank offers accounts to businesses that accept payment cards.
Before you can accept payments, you must have a merchant bank account from an
acquiring bank. Your merchant bank account must be configured to process card-not-
present or mail order/telephone order (MOTO) transactions.

Each acquiring bank has connections to a limited number of payment

processors. You must choose a payment processor that your acquiring bank
Note supports. See "Payment Processors," page 32.

Expect to be charged the fees shown in the following table.

Table 7 Fees

Fee Description
Discount rates Your acquiring bank charges a fee and collects a percentage of every
transaction. The combination of the fee and the percentage is called the discount
rate. These charges can be bundled (combined into a single charge) or
unbundled (charged separately) depending on your acquiring bank and other
factors.
Interchange Visa and Mastercard each have a base fee, called the interchange fee, for each
fees type of transaction. Your acquiring bank and processor can explain how to
minimize this fee.
Chargebacks When customers dispute charges to their accounts, you can incur chargebacks.
A chargeback occurs when a charge on a customer’s account is reversed. Your
merchant bank removes the money from your account and could charge you a
fee for the chargeback.

You are responsible for maintaining:

 Good customer support
 Rapid problem resolution
 A high level of customer satisfaction
 Transaction management processes that minimize fraudulent transactions

Credit Card Services Using the Simple Order API | September 2019 28
 Chapter 1 Introduction to the Credit Card Services

The items in the preceding list are required to prevent an excessive number of credit card
chargebacks. In the event that credit card chargebacks become excessive, CyberSource
can require you to undertake business process changes to reduce chargebacks. If the
chargebacks are not reduced to a satisfactory level, CyberSource can terminate your
account.

If you receive a large number of chargebacks or if a large number of your transactions

involve fraud, your acquiring bank might increase your discount rate or revoke your
merchant bank account. Contact CyberSource for information about CyberSource
products that can help prevent fraud.

Issuing (Consumer) Banks

An issuing, or consumer, bank provides payment cards to and underwrites lines of credit
for consumers. The issuing bank provides monthly statements and collects payments.
Issuing banks must follow the rules of the payment card companies to which they belong.

Payment Card Companies

Payment card companies manage communications between acquiring banks and issuing
banks. They also develop industry standards, support their brands, and establish fees for
acquiring banks.

Some payment card companies, such as Visa and Mastercard, are trade associations that
do not issue cards. Instead, issuing banks are members of these associations and they
issue cards under license from the associations.

Other card companies, such as Discover and American Express, act as the issuing banks
for their own cards. Before you use CyberSource to process cards from these companies,
you must sign agreements with the companies.

Credit Card Services Using the Simple Order API | September 2019 29
 Chapter 1 Introduction to the Credit Card Services

Services
The credit card services are:
 Authorization: see "Authorizing a Payment," page 38.
 Full authorization reversal: see "Reversing an Authorization," page 52.
 Capture: see "Capturing an Authorization," page 61.
 Credit: see "Crediting a Payment," page 78.
 Void: see "Voiding a Capture or Credit," page 85. This service is not restricted to the
credit card services; it can also be used for other payment methods.

You can also request an authorization and capture together. See "Performing a Sale,"
page 75.

Order Tracking
See Getting Started with CyberSource Advanced for the Simple Order API for information
about order tracking. This section provides the names of the API fields that are used for
order tracking for the credit card services.

Request IDs
For all CyberSource services, the request ID is returned in the reply messages in
requestID. The following table lists the fields for the request IDs in request messages.

Table 8 Fields for Request IDs in Request Messages

Service Request ID Field

Authorization reversal ccAuthReversalService_authRequestID
Capture ccCaptureService_authRequestID
Credit ccCreditService_captureRequestID
Void voidService_voidRequestID

Credit Card Services Using the Simple Order API | September 2019 30
 Chapter 1 Introduction to the Credit Card Services

Reconciliation IDs
The following table lists the fields for the reconciliation IDs, which are returned in the reply
messages.

Table 9 Fields for Reconciliation IDs

Service Reconciliation ID Field Notes

Authorization ccAuthReply_reconciliationID For authorization requests, the
reconciliation ID is returned only for
these processors:
 American Express Direct
 Asia, Middle East, and Africa
Gateway
 Atos
 BML Direct
 Chase Paymentech Solutions
 Cielo
 CyberSource through VisaNet
 FDC Compass
 FDC Nashville Global
 Moneris
 Worldpay VAP
Worldpay VAP was previously
called Litle.
Authorization ccAuthReversalReply_ For authorization reversal requests,
reversal reconciliationID the reconciliation ID is returned only
for Cielo and Moneris.
Capture ccCaptureReply_reconciliationID The reconciliation ID is returned for all
capture requests for all processors
except JCN Gateway and RBS
WorldPay Atlanta.
When you perform multiple partial
captures for an authorization, each
reply includes a different reconciliation
ID for each capture request. To learn
whether your processor supports
multiple partial captures, see "Multiple
Partial Captures," page 71.
Credit ccCreditReply_reconciliationID The reconciliation ID is returned for all
credit requests for all processors
except JCN Gateway.

Credit Card Services Using the Simple Order API | September 2019 31
 Chapter 1 Introduction to the Credit Card Services

On CyberSource through VisaNet, the reconciliation ID is mapped to the

purchase identifier field which is sent to your acquirer.
Note

JCN Gateway does not support the reconciliation ID for any services.

Note

Payment Processors

In this document, the word processor can refer to processors, acquirers, or

acquiring processors depending on your location.
Note

Payment processors connect CyberSource servers with acquiring banks. Before you can
accept payments, you must register with a payment processor. Your acquiring bank might
require you to use a payment processor with which the bank has a business relationship.

CyberSource does not necessarily support all the features that are offered by each
processor. This guide describes the payment processing features supported by
CyberSource. The beginning of each feature description specifies which payment
processors support the feature.

Your processor provides you with unique identification numbers for your account. You
must provide these identification numbers to CyberSource Customer Support.

The following table lists the processors and corresponding card types that CyberSource
supports for the credit card services.

Only the card types explicitly listed here are supported.

Note

Credit Card Services Using the Simple Order API | September 2019 32
 Chapter 1 Introduction to the Credit Card Services

Table 10 Payment Processors and Card Types

Payment Processor Supported Card Types & Notes

AIBMS Visa, Mastercard, Maestro (International),
Maestro (UK Domestic)
American Express Brighton American Express
Depending on the country in which your business is located,
you might need to get special permission from American
Express before you can process transactions with American
Express Brighton. For more information, contact American
Express.
American Express Direct American Express
Asia, Middle East, and Africa Visa, Mastercard, American Express, Diners Club, JCB
Gateway
Atos Visa, Mastercard, Diners Club, JCB, Cartes Bancaires,
Maestro (UK Domestic)
Barclays Visa, Mastercard, JCB, Maestro (International),
Maestro (UK Domestic)
If you support Maestro (UK Domestic), you must also
support Maestro (International), and you must support
Mastercard Identity Check for both card types.
GBP currency only for JCB and Maestro (UK Domestic).
Chase Paymentech Solutions Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Carte Blanche, Maestro (International)
Cielo Cielo 1.5
Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Maestro (International), Elo, Aura, Visa Electron
Cielo 3.0
Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Maestro (International), Elo, Aura, Visa Electron,
Hipercard
Maestro (International)
The Maestro (International) card type is processed the same
way that the Mastercard debit card is processed. Use card
type value 002 (Mastercard) and use the ccAuthService_
overridePaymentMethod field to indicate that it is a debit
card.
Visa Electron
The Visa Electron card type is processed the same way that
the Visa debit card is processed. Use card type value 001
(Visa).
Citibank India For details about the Citibank India processor, contact your
CyberSource sales representative.

Credit Card Services Using the Simple Order API | September 2019 33
 Chapter 1 Introduction to the Credit Card Services

Table 10 Payment Processors and Card Types (Continued)

Payment Processor Supported Card Types & Notes

Comercio Latino Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Elo, Aura, Hipercard
Note For Hipercard, Comercio Latino supports only 16-digit
and 19-digit card numbers.
Comercio Latino is the upgraded version of CyberSource
Latin American Processing.
If Rede is your acquirer, you must inform Comercio Latino of
your Rede portal username and password.
Important If Banorte is your acquirer, the currency that is
stored in the Banorte merchant account database overrides
the currency included in the transaction request. The
supported currencies are MXN (Mexican peso) and USD
(United States dollar).
Credit Mutuel-CIC Visa, Mastercard, Cartes Bancaires
CyberSource Latin American Not all card types are supported in all Latin American
Processing countries. Contact CyberSource Customer Support for
details.
For the current processing connection to Latin America, use
Comercio Latino.
For some countries, you are required to submit the
authorization request and the capture request together in the
same message.

Note CyberSource Latin American Processing is the name

of a specific processing connection that CyberSource
supports. In the CyberSource API documentation,
CyberSource Latin American Processing does not refer to
the general topic of processing in Latin America.

CyberSource through VisaNet See Appendix K, "CyberSource through VisaNet Acquirers,"

on page 480 for the list of acquirers that are supported for
CyberSource through VisaNet and the card types supported
for each acquirer.
The Visa Electron card type is processed the same way that
the Visa debit card is processed. Use card type value 001
(Visa) for Visa Electron.
Elavon Visa, Mastercard, Discover, Diners Club,
Maestro (UK Domestic), Maestro (International)
Elavon Americas Visa, Mastercard, American Express, JCB, Diners Club,
Discover, China UnionPay
FDC Compass Visa, Mastercard, American Express, Discover, Diners Club,
JCB
FDC Germany Visa, Mastercard, Maestro (UK Domestic),
Maestro (International)

Credit Card Services Using the Simple Order API | September 2019 34
 Chapter 1 Introduction to the Credit Card Services

Table 10 Payment Processors and Card Types (Continued)

Payment Processor Supported Card Types & Notes

FDC Nashville Global Visa, Mastercard, American Express, Discover, Diners Club,
JCB, China UnionPay
FDI Australia Visa, Mastercard, American Express, Diners Club, JCB
FDMS Nashville Visa, Mastercard, American Express, Discover, Diners Club,
Carte Blanche, JCB
FDMS South Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Carte Blanche
Important FDMS South does not accept authorization
requests. If FDMS South is your processor, you need to
either update or migrate your account depending on your
settlement currency.
If you settle transactions in CAD, you must do the following:
 Contact CyberSource Customer Support to have your
CyberSource account configured to send authorization
requests to a third party who will forward the requests to
FDMS South on your behalf.
 Contact First Data to have your First Data account
updated.
If you settle transactions in USD, CyberSource recommends
that you change your processor to FDC Nashville Global,
FDMS Nashville, or FDC Compass.
Getnet Visa, Mastercard, American Express, Elo, Hipercard
GPN Visa, Mastercard, American Express, Discover, Diners Club,
JCB
GPN is the CyberSource name
for Global Payments, Inc.’s East Note USD is the only currency supported with American
processing platform. Express, Discover, Diners Club, and JCB. With Visa and
Mastercard, you can use any currency that is supported by
both GPN and CyberSource.
HBoS Visa, Mastercard, Maestro (UK Domestic),
Maestro (International)
HSBC Visa, Mastercard, Maestro (UK Domestic),
Maestro (International)
HSBC is the CyberSource name
for HSBC U.K.
Ingenico ePayments Visa, Mastercard, American Express, JCB,
Maestro (UK Domestic), Delta, Visa Electron, Dankort,
Ingenico ePayments was
Cartes Bancaires, Carta Si, Eurocard
previously called Global Collect.
Important CyberSource does not support Diners Club or
Discover for payment card processing with Ingenico
ePayments. A payment request using one of these card
types will not result in a successful transfer of funds to your
merchant account. CyberSource does not plan to add
support for these card types on Ingenico ePayments.
JCN Gateway Visa, Mastercard, American Express, Diners Club, JCB

Credit Card Services Using the Simple Order API | September 2019 35
 Chapter 1 Introduction to the Credit Card Services

Table 10 Payment Processors and Card Types (Continued)

Payment Processor Supported Card Types & Notes

Lloyds-OmniPay Visa, Mastercard, Maestro (UK Domestic),
Maestro (International)
LloydsTSB Cardnet Visa, Mastercard, Maestro (UK Domestic)
Lynk Visa, Mastercard, American Express, Discover, Diners Club,
Carte Blanche, JCB
Moneris Visa, Mastercard, American Express, Discover
OmniPay Direct Supported acquirers:
 Bank of America Merchant Services: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
 Cardnet International: Visa, Mastercard, Discover, Diners
Club, Maestro (UK Domestic), Maestro (International),
Visa Electron
 First Data Merchant Solutions (Europe): Visa, Mastercard,
Discover, Diners Club, Maestro (UK Domestic),
Maestro (International)
 Global Payments International Acquiring: Visa,
Mastercard, Maestro (UK Domestic),
Maestro (International)
OmniPay-Ireland Visa, Mastercard
OmniPay-Ireland is the
CyberSource name for HSBC
International.
PayEase China Processing Visa, Mastercard, American Express, JCB
The information in this guide does not apply to PayEase
China Processing. All information required for PayEase
China Processing is in the China Processing Implementation
Guide.
RBS WorldPay Atlanta Visa, Mastercard, American Express, Discover, Diners Club,
JCB
Rede Visa, Mastercard, American Express, Diners Club, JCB, Elo,
Hipercard
RuPay RuPay
SIX Visa, Mastercard, Discover, Diners Club, JCB,
Maestro (International), Maestro (UK Domestic),
China UnionPay, Visa Electron
Use card type value 033 for Visa Electron.
Software Express Supported acquirer: Getnet
Support card types: Visa, Mastercard

Credit Card Services Using the Simple Order API | September 2019 36
 Chapter 1 Introduction to the Credit Card Services

Table 10 Payment Processors and Card Types (Continued)

Payment Processor Supported Card Types & Notes

Streamline Visa, Mastercard, JCB, Cartes Bancaires, Dankort,
Maestro (International), Maestro (UK Domestic)
For Maestro (International), Identity Check processing is
required.
TSYS Acquiring Solutions Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Carte Blanche
UATP UATP
Worldpay VAP Visa, Mastercard, American Express, Discover, Diners Club,
JCB
Worldpay VAP was previously
called Litle.

Credit Card Services Using the Simple Order API | September 2019 37
 CHAPTER
Payment Card Processing
2

Authorizing a Payment
CyberSource supports authorizations for all processors.

Online Authorizations
Online authorization means that when you submit an order using a payment card, you
receive an immediate confirmation about the availability of the funds. If the funds are
available, the issuing bank reduces your customer’s open to buy, which is the amount of
credit available on the card. Most of the common payment cards are processed online. For
online authorizations, you typically start the process of order fulfillment soon after you
receive confirmation of the order.

Online authorizations expire with the issuing bank after a specific length of time if they
have not been captured and settled. Most authorizations expire within five to seven days.
The issuing bank sets the length of time.

CyberSource is not informed by the issuing bank when an authorization

expires. By default, the authorization remains in the CyberSource system for 60
Note days after the authorization date, even after it expires with the issuing bank.

When an authorization expires with the issuing bank, your bank or processor might require
you to resubmit an authorization request and include a request for capture in the same
message.

Credit Card Services Using the Simple Order API | September 2019 38
 Chapter 2 Payment Card Processing

The following figure shows the steps that occur when you request an online credit card
authorization.

Figure 1 Processing an Online Authorization

1 The customer places an order and provides the payment card number, the card expiration
date, and additional information about the card.

2 You send a request for authorization over a secure Internet connection. When the
customer buys a digitally delivered product or service, you can request both the
authorization and the capture at the same time. When the customer buys a physically
fulfilled product, do not request the capture until you ship the product.

3 CyberSource validates the order information then contacts your payment processor and
requests authorization.

4 The processor sends the transaction to the payment card company, which routes it to the
issuing bank for the customer’s payment card. Some card companies, including Discover
and American Express, act as their own issuing banks.

5 The issuing bank approves or declines the request.

Depending on the processor and card type, the issuing bank can use AVS to confirm the
billing address and CVN to verify that the customer has possession of the card. See
Chapter 3, "Authorization Features," on page 88.

For debit cards and prepaid cards, the issuing bank can approve a partial amount if the
balance on the card is less than the requested authorization amount and if the transaction
is enabled for partial authorization. For details about partial authorizations and for a list of
the processors and card types supported for partial authorizations, see "Partial
Authorizations," page 105.

For a limited number of processors and card types, partial authorizations

and balance responses are supported for credit cards in addition to debit
Note cards and prepaid cards. See "Partial Authorizations," page 105, and
"Balance Responses," page 111.

6 CyberSource runs its own tests then tells you whether the authorization succeeded.

Credit Card Services Using the Simple Order API | September 2019 39
 Chapter 2 Payment Card Processing

Offline Authorizations
Offline authorization means that when you submit an order using a payment card, you do
not know whether the funds are available until you capture the order and receive
confirmation of payment. You typically do not ship the goods until you receive this payment
confirmation. For offline payment cards, it usually takes five days longer to receive
payment confirmation than for online cards.

Automatic Captures
Processors:
 Asia, Middle East, and Africa Gateway
 Cielo
 Comercio Latino
 CyberSource Latin American Processing

An automatic capture is an authorization that results in an immediate capture if the

authorization is approved. A bundled request means that an authorization and a capture
are requested at the same time.

To enable automatic captures for your account, contact CyberSource Customer Support.

Automatic captures are requested two ways:

 If automatic captures are enabled for your account, submit a bundled request.

 If automatic captures are not enabled for your account, submit a bundled request and
set ccAuthService_authType to AUTOCAPTURE.

If your account is configured to enable automatic captures but you want to process a
standard capture for a specific transaction, submit a bundled or standard authorization
request and set ccAuthService_authType to STANDARDCAPTURE. The authorization is
processed immediately, and if it is successful, the capture is processed during the next
settlement submission cycle.

Credit Card Services Using the Simple Order API | September 2019 40
 Chapter 2 Payment Card Processing

Authorization reversal and void services are not supported for automatic capture
transactions.
Table 11 Automatic Capture Information for Specific Processors

Payment Processor Automatic Capture Information

Asia, Middle East, and Africa Certain acquirers that are connected to the Asia, Middle East,
Gateway and Africa Gateway require automatic captures. Contact your
CyberSource Customer Support representative to learn whether
your acquirer uses standard or automatic capture processing.
Cielo By default, your CyberSource account is configured to support
standard capture processing. When you contact Customer
Support to set up your account, you can request that the default
type of capture be automatic capture instead of standard
capture.
All Aura Card transactions must be automatic captures.
Comercio Latino When you contact Customer Support to set up your account,
you can request that the default type of capture be automatic
capture instead of standard capture.
CyberSource Latin American With CyberSource Latin American Processing, for some
Processing countries you are required to submit an automatic capture. For
other countries, you can submit standard authorization and
capture requests. Contact CyberSource Customer Support for
each country’s requirements.

Note CyberSource Latin American Processing is the name of a

specific processing connection that CyberSource supports. In
the CyberSource API documentation, CyberSource Latin
American Processing does not refer to the general topic of
processing in Latin America.

Creating an Authorization Request

Step 1 Do not include any of these services in the request:

 Full authorization reversal (ccAuthReversalService)

 Credit (ccCreditService)

 Services for other payment methods, such as electronic checks or PayPal

 Risk update (riskUpdateService)

Credit Card Services Using the Simple Order API | September 2019 41
 Chapter 2 Payment Card Processing

Step 2 Include the required fields in the request:

 If you are using Apple Pay, see Apple Pay Using the Simple Order API.

 If you are using Google Pay, see Google Pay Using the Simple Order API.

 If you are using Visa Checkout or Visa Secure Remote Commerce, see Table 12 for
the required fields:

Table 12 Required Fields for Authorizations with Visa Checkout or Visa

Secure Remote Commerce

Field Notes
ccAuthService_run Set to true.
merchantID
merchantReferenceCode
paymentSolution Set to visacheckout.
purchaseTotals_currency
purchaseTotals_ Either purchaseTotals_grandTotalAmount or item_#_
grandTotalAmount unitPrice must be included in the request.
vc_orderID
wallet_type Required only on CyberSource through VisaNet.

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Optional request fields
 Reply fields

 Otherwise, see Table 13 for the required fields:

Table 13 Required Fields for Authorizations

without Visa Checkout or Visa Secure Remote Commerce

Field Notes
billTo_city1
billTo_country1
billTo_email1
billTo_firstName1
billTo_lastName1
billTo_postalCode1 Required only for transactions in the U.S. and Canada.
1 This field is optional if your CyberSource account is configured for relaxed requirements for address
data and expiration date. See "Relaxed Requirements for Address Data and Expiration Date,"
page 91. Important It is your responsibility to determine whether a field is required for the
transaction you are requesting.

Credit Card Services Using the Simple Order API | September 2019 42
 Chapter 2 Payment Card Processing

Table 13 Required Fields for Authorizations

without Visa Checkout or Visa Secure Remote Commerce

Field Notes
1
billTo_state Required only for transactions in the U.S. and Canada.
1
billTo_street1
card_accountNumber
card_cardType Required for certain card types. CyberSource strongly
recommends that you send the card type even if it is optional
for your processor. Omitting the card type can cause the
transaction to be processed with the wrong card type.
card_expirationMonth1
card_expirationYear1
ccAuthService_run Set to true.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_ Either purchaseTotals_grandTotalAmount or item_#_
grandTotalAmount unitPrice must be included in the request.
1 This field is optional if your CyberSource account is configured for relaxed requirements for address
data and expiration date. See "Relaxed Requirements for Address Data and Expiration Date,"
page 91. Important It is your responsibility to determine whether a field is required for the
transaction you are requesting.

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Optional request fields
 Reply fields

Step 3 If needed, modify the request to accommodate additional information for your processor.
See "Authorization Information for Specific Processors," page 48.

Step 4 Include authorization features in the request.

There are several authorization features that can be performed automatically depending
on the information included in your request. These features are described in Chapter 3,
"Authorization Features," on page 88.

Step 5 Include optional features in the request.

There are several optional features that you can include in your request. These features
are described in Chapter 5, "Optional Features," on page 116.

Credit Card Services Using the Simple Order API | September 2019 43
 Chapter 2 Payment Card Processing

Checking the Status of an Authorization Request

Processor:
 RuPay

Card type:
 RuPay

Typically, when a timeout occurs during an authorization, CyberSource automatically

performs an authorization reversal. However, RuPay does not support online authorization
reversals. When a timeout occurs during an authorization for a RuPay transaction,
CyberSource includes a ccAuthReply_reasonCode field set to 151 in the authorization
reply message. When you receive this value, check the status of the authorization by
requesting the check status service.

The check status service includes a payment status field in the reply message. When the
value of the payment status field is AUTHORIZED, proceed with the order by requesting
the capture service. When the value of the payment status field is DECLINED, the
authorization has been declined. You can request a different form of payment from the
customer.

To create a check status request:

Step 1 Do not include any other services in the request.

Step 2 Include the required fields in the request:

Table 14 Required Fields for the Check Status Service

Field Notes
ccCheckStatusService_ Set to the request ID in the reply message for the authorization
authRequestID you want to check.
ccCheckStatusService_run Set to true.
merchantID
merchantReferenceCode

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Reply fields

Credit Card Services Using the Simple Order API | September 2019 44
 Chapter 2 Payment Card Processing

Incremental Authorizations

The incremental authorization service is not the same as a merchant-initiated

transaction. For information about incremental authorizations that are
Note merchant-initiated transactions, see "Incremental Authorization," page 179.

Processor:
 CyberSource through VisaNet

Card types:
 Mastercard
 Visa

Incremental authorizations are useful when a customer adds products and services to an
original purchase. After a successful original authorization, the incremental authorization
service enables you to:
 Request subsequent authorizations.
 Request one capture for the original and incremental authorizations.

Limitations
 Maximum of 100 incremental authorizations per transaction, in addition to the original
authorization.
 Interchange optimization is not supported.
 Split shipments are not supported.

Incremental Authorization Scenario

1 The customer reserves a hotel room for two nights at a cost of 200.00 per night. You
request an authorization for 400.00. The authorization request is approved.

2 The customer orders dinner through room service the first night. You request an
incremental authorization of 50.00 for the dinner.

3 The customer decides to stay an extra night. You request an incremental authorization of
200.00 for the additional night.

4 The customer uses items from the mini-bar. The cost of the mini-bar items is 50.00. You
request an incremental authorization of 50.00.

5 When the customer ends their stay and checks out, they sign a receipt for 700.00, which is
the total of all costs incurred.

6 You request a capture for 700.00.

Credit Card Services Using the Simple Order API | September 2019 45
 Chapter 2 Payment Card Processing

Supported Features
 Authorization reversals with Mastercard. The reversal amount is the amount of the
original authorization plus the amounts for all incremental authorizations. In the
authorization reversal request, set the request ID to the request ID that was returned
in the reply for the original authorization. See "Reversing an Authorization," page 52.

 Authorization reversals with Visa. You can reverse any of the following amounts. See
"Reversing an Authorization," page 52.

 Amount of the original authorization plus the amounts for all incremental
authorizations. In the authorization reversal request, set the request ID to the
request ID that was returned in the reply for the original authorization.

 Amount of any one of the incremental authorizations. In the authorization reversal

request, set the request ID to the request ID that was returned in the reply for the
incremental authorization.

 Final authorization indicator. See "Final Authorization Indicator," page 138.

 Merchant descriptors. When you include merchant descriptors in the original

authorization request, CyberSource uses those merchant descriptors for all
incremental authorizations that are associated with the original authorization. See
"Merchant Descriptors," page 169.

 Merchant-initiated reversals. See "Merchant-Initiated Reversals and Voids," page 170.

Merchant-initiated voids are not supported.

 Merchant-initiated transactions. See "Merchant-Initiated Transactions (MITs) and

Credentials-on-File (COF) Transactions," page 173.

 Partial authorizations for an original authorization. This feature is supported only for
an original authorization made with a debit card or prepaid card. You can request an
incremental authorization after a partial original authorization, but the incremental
authorization cannot result in a partial authorization. See "Partial Authorizations,"
page 105.

Credit Card Services Using the Simple Order API | September 2019 46
 Chapter 2 Payment Card Processing

Performing an Incremental Authorization

Step 1 Request an authorization. See "Creating an Authorization Request," page 41.

Step 2 Include the following required fields in each request for an incremental authorization:

Table 15 Required Fields for Incremental Authorizations

Field Notes
ccIncrementalAuthService_authRequestID Set to the request ID that was included in the
original authorization reply message.
ccIncrementalAuthService_run Set to true.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount Either purchaseTotals_grandTotalAmount or
item_#_unitPrice must be included in the
request.
CyberSource through VisaNet limits
authorization and capture amounts to 12 digits;
therefore, the maximum amount is
999999999999.
subsequentAuthReason

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Optional request fields
 Reply fields

Step 3 When you request the capture, CyberSource recommends that you set the capture
amount to the amount of the original authorization plus the amounts for all incremental
authorizations.

If the requested capture amount is less than the amount of the original authorization plus
the amounts for all incremental authorizations, CyberSource automatically performs a
partial authorization reversal. See "Automatic Partial Authorization Reversals," page 69.

If the requested capture amount is more than the amount of the original authorization plus
the amounts for all incremental authorizations, CyberSource does not reject the capture
request.

See "Capturing an Authorization," page 61.

Credit Card Services Using the Simple Order API | September 2019 47
 Chapter 2 Payment Card Processing

Authorization Information for Specific Processors

The following table provides additional information about authorizations for specific
processors.

Table 16 Authorization Information for Specific Processors

Payment Processor Authorization Information

American Express Direct For USD, American Express Direct limits authorization and
capture amounts to 9,999,999.00. For other currencies, the
maximum amount depends on the currency. Contact American
Express for the maximum amounts for the currencies that you
are using. Regardless of exponent or currency, the maximum
number of digits for the amount value is 12 digits.
Asia, Middle East, and The Asia, Middle East, and Africa Gateway limits authorization
Africa Gateway and capture amounts to four bytes; therefore, the maximum
amount is 2147483647.
Certain acquirers that are connected to the Asia, Middle East,
and Africa Gateway require that an authorization be
automatically captured. See "Automatic Captures," page 40.
Atos Atos limits authorization, capture, and credit amounts to 12
digits; therefore, the maximum amount is 999999999999.
Important Authorizations time out after 5 days, 20 hours, and
30 minutes. For Maestro (UK Domestic), when you submit a
capture request after 5 days, 20 hours, and 30 minutes, you
must reauthorize first. For all other card types, when you submit
a capture request after 5 days, 20 hours, and 30 minutes,
CyberSource tries to obtain a fresh authorization as described in
"Authorization Refresh," page 68.
Barclays CyberSource rounds the amount to the correct number of
decimal places for the currency.
Barclays supports enhanced response codes in authorization
reply messages. Enhanced response codes provide detailed
information about declined transactions. Contact Barclays
customer support to have this capability enabled for your
Barclays account.

Credit Card Services Using the Simple Order API | September 2019 48
 Chapter 2 Payment Card Processing

Table 16 Authorization Information for Specific Processors (Continued)

Payment Processor Authorization Information

Cielo Automatic Capture and Standard Capture
Cielo supports standard captures and automatic captures.
 By default, your CyberSource account is configured to
support standard capture processing.
 For an Aura Card transaction, you must set the authorization
type to AUTOCAPTURE. See "Automatic Captures," page 40.
Combo Cards
Some card types support two payment methods: they can be
processed as credit cards and debit cards. On Cielo:
 The default payment method is credit card.
 You can override the default payment method by including the
ccAuthService_overridePaymentMethod field, a flag that
indicates whether the card is being used as a credit card or
debit card, in the authorization request.
Debit Cards
For debit cards on Cielo:
 You must request an automatic capture. See "Automatic
Captures," page 40.
 You must include payer authentication data in the request for
cards that support it on the Cielo gateway. For a description
of payer authentication, see "Payer Authentication,"
page 186.
 Some card types must always be processed as debit cards
and must be identified with the override payment method
field. Cards that must always be processed as debit cards
include:
 Visa Electron
 Maestro (International)

Credit Card Services Using the Simple Order API | September 2019 49
 Chapter 2 Payment Card Processing

Table 16 Authorization Information for Specific Processors (Continued)

Payment Processor Authorization Information

Comercio Latino Regardless of exponent or currency, the maximum number of
digits for the amount value is 19 digits. This maximum amount
may be subject to further restrictions based on the acquirer
requirements.
Debit Cards
For debit cards on Comercio Latino:
 You must request an automatic capture. See "Automatic
Captures," page 40.
 You must include payer authentication data in the request for
cards that support it on the Comercio Latino gateway. For a
description of payer authentication, see "Payer
Authentication," page 186.
 Some card types must always be processed as debit cards
and must be identified with the ccAuthService_
overridePaymentMethod field. Cards that must always be
processed as debit cards include:
 Visa Electron
 Maestro (International)
CyberSource Latin American With CyberSource Latin American Processing, for some
Processing countries you must submit an automatic capture. See
"Automatic Captures," page 40. For other countries, you can
submit standard authorization and capture requests. Contact
CyberSource Customer Support for each country’s
requirements.
For transactions in Brazil, you must request the follow-on
capture within five days of the authorization request.

Note CyberSource Latin American Processing is the name of a

specific processing connection that CyberSource supports. In
the CyberSource API documentation, CyberSource Latin
American Processing does not refer to the general topic of
processing in Latin America.

CyberSource through CyberSource through VisaNet limits authorization and capture

VisaNet amounts to 12 digits; therefore, the maximum amount is
999999999999.
When you perform a reauthorization or an incremental
authorization, your authorization request must include
subsequent authorization fields as described in "Merchant-
Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

Credit Card Services Using the Simple Order API | September 2019 50
 Chapter 2 Payment Card Processing

Table 16 Authorization Information for Specific Processors (Continued)

Payment Processor Authorization Information

FDMS South For the Indonesian rupiah (IDR) and Chilean peso (CLP)
currencies only:
 Rounding occurs, which can cause a minor discrepancy that
consists of a maximum of one currency unit between the
amount you requested and the amount that is authorized.
 When a transaction is enabled for partial authorization, you
must ensure that the requested amount does not include any
digits to the right of the decimal separator. For a description of
partial authorizations, see "Partial Authorizations," page 105.
GPN GPN limits the authorization, capture, and credit amounts to 10
digits.
Ingenico ePayments For Cartes Bancaires, the authorization and capture amount
must be 0.99 EUR or more.
Ingenico ePayments was
previously called Global
Collect.
Moneris Moneris limits authorization and capture amounts to nine digits;
therefore, the maximum amount is 9999999.99.
RBS WorldPay Atlanta RBS WorldPay Atlanta limits the authorization, capture, and
credit amounts to the equivalent of 999,999.99 USD.
Depending on the value you send, the decimal is either
truncated or appended. For example, if you send 1.123 the
decimal is truncated to 1.12. If you send 123 it is converted to
123.00.
RuPay RuPay requires payer authentication for all authorization
requests. See "RuPay PaySecure," page 196.
The reply message for the payer authentication check
enrollment service indicates whether a card requires single-
message processing or dual-message processing. For cards
that require single-message processing, see "Single-Message
Processing," page 76.
In the authorization request, the e-commerce indicator must be
rpy.
When you do not receive an authorization reply message from
CyberSource, request the check status service. See "Checking
the Status of an Authorization Request," page 44.
SIX A request for an authorization must include a capture request.

Credit Card Services Using the Simple Order API | September 2019 51
 Chapter 2 Payment Card Processing

Table 16 Authorization Information for Specific Processors (Continued)

Payment Processor Authorization Information

Streamline Streamline limits authorization and capture amounts to 11 digits;
therefore, the maximum amount is 999999999.99.
Streamline supports enhanced response codes in authorization
reply messages. Enhanced response codes provide detailed
information about declined transactions. Contact Streamline
customer support to have this capability enabled for your
Streamline account.
TSYS Acquiring Solutions TSYS Acquiring Solutions limits authorization and capture
amounts to the equivalent of 99,999.99 USD. To process an
amount greater than this, contact TSYS Acquiring Solutions.
Worldpay VAP Worldpay VAP limits authorization and capture amounts to eight
digits; therefore, the maximum amount is 99999999.
Worldpay VAP was
previously called Litle.

Reversing an Authorization
The full authorization reversal service releases the hold that the authorization placed on
the customer’s credit card funds. Use this service to reverse an unnecessary or undesired
authorization.

Each issuing bank has its own rules for deciding whether a full authorization
reversal succeeds or fails. When a reversal fails, contact the issuing bank to
Note learn whether it is possible to reverse the authorization by alternate means.

If your processor supports authorization reversal after void (ARAV), you can reverse an
authorization after you void the associated capture. See "Authorization Reversal after Void
(ARAV)," page 59. If your processor does not support ARAV, you can use the full
authorization reversal service only for an authorization that has not been captured and
settled.

Credit Card Services Using the Simple Order API | September 2019 52
 Chapter 2 Payment Card Processing

Supported Processors and Card Types

The following table lists the processors that are supported for full authorization reversals.
For processors that support debit cards and prepaid cards, the full authorization reversal
service works for debit cards and prepaid cards in addition to credit cards.

Table 17 Processors That Support Full Authorization Reversals

Processor Card Types and Notes

AIBMS Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
American Express Direct Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact American Express for more information.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Barclays Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
CyberSource supports enhanced authorization reversals on
this processor; therefore, CyberSource sends the processor
extra data in the authorization reversal request. You do not
need to process or monitor the extra data.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Chase Paymentech Solutions Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Maestro (International),
Discover, and Diners Club.
Time limit: a full authorization reversal must occur within
three days of the authorization.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Cielo Card types supported for full authorization reversals: Visa,
Mastercard, American Express.
Comercio Latino Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Discover, Diners Club, JCB,
Elo, Aura, Hipercard.
Time limit: a full authorization reversal must occur by 23:59
BRT (UTC-3) on the same day as the authorization.
Credit Mutuel-CIC Visa, Mastercard, Cartes Bancaires

Credit Card Services Using the Simple Order API | September 2019 53
 Chapter 2 Payment Card Processing

Table 17 Processors That Support Full Authorization Reversals (Continued)

Processor Card Types and Notes

CyberSource through VisaNet Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Diners Club, JCB, Discover,
mada as described in "mada Debit Cards," page 24.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Important For mada, see "Authorization Reversals for
Single-Message Processing," page 59.
Elavon Card types supported for full authorization reversals: Visa,
Mastercard, Discover, Diners Club, Maestro (UK Domestic),
Maestro (International).
Time limit: a full authorization reversal must occur within 24
hours of the authorization.
Elavon Americas Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Discover, Diners Club, JCB,
and China UnionPay.
FDC Compass Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Discover, Diners Club, and
JCB.
Time limit: a full authorization reversal must occur within
three days of the authorization.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
FDC Germany Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
FDC Nashville Global Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic), China UnionPay.
For JCB cards, “US Domestic” means that the currency is
USD and your location is the U.S., Puerto Rico, Guam, U.S.
Virgin Islands, or Northern Mariana Islands.
For Discover, Diners Club, and JCB (US Domestic), full
authorization reversals are supported for USD transactions
only. There are no currency restrictions for full authorization
reversals for Visa, Mastercard, and American Express.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
FDI Australia Visa, Mastercard, American Express, Diners Club, JCB

Credit Card Services Using the Simple Order API | September 2019 54
 Chapter 2 Payment Card Processing

Table 17 Processors That Support Full Authorization Reversals (Continued)

Processor Card Types and Notes

FDMS Nashville Card types supported for full authorization reversals: Visa,
Mastercard, Discover, Diners Club, and JCB (US Domestic).
For JCB cards, “US Domestic” means that the currency is
USD and your location is the U.S., Puerto Rico, Guam, U.S.
Virgin Islands, or Northern Mariana Islands.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
FDMS South Card types supported for full authorization reversals: Visa,
Mastercard, Discover, and JCB (US Domestic).
For JCB cards, “US Domestic” means that the currency is
USD and your location is the U.S., Puerto Rico, Guam, U.S.
Virgin Islands, or Northern Mariana Islands.
Full authorization reversals:
 Are supported only for transactions that do not go through
a currency conversion.
 Are supported for the following types of merchants and
currencies:
 Merchants located in the U.S. who authorize, settle,
and fund in U.S. dollars.
 Merchants located in Canada who authorize, settle,
and fund in Canadian dollars.
 Merchants located in Latin America or the Caribbean
who authorize, settle, and fund in U.S. dollars.
 Merchants located in Europe who authorize, settle, and
fund in the currency for the country in which the
merchant is located.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Getnet Visa, Mastercard, American Express, Elo, Hipercard
GPN Card types supported for full authorization reversals: Visa,
Mastercard, Discover, Diners Club, and JCB.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
HBoS Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
HSBC Card types supported for full authorization reversals: Visa,
Mastercard, Maestro (UK Domestic), Maestro (International).
HSBC is the CyberSource name
for HSBC U.K. Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.

Credit Card Services Using the Simple Order API | September 2019 55
 Chapter 2 Payment Card Processing

Table 17 Processors That Support Full Authorization Reversals (Continued)

Processor Card Types and Notes

JCN Gateway Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Diners Club, JCB.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Lloyds-OmniPay Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
LloydsTSB Cardnet Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Moneris Card types supported for full authorization reversals: Visa,
Mastercard, American Express, and Discover.
OmniPay Direct Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
Card types supported for full authorization reversals on each
acquirer:
 Bank of America Merchant Services: Visa, Mastercard,
Maestro (UK Domestic), and Maestro (International).
 Cardnet International: Visa, Mastercard,
Maestro (UK Domestic), and Maestro (International).
 First Data Merchant Solutions (Europe): Visa, Mastercard,
Discover, Diners Club, Maestro (UK Domestic), and
Maestro (International).
 Global Payments International Acquiring: Visa,
Mastercard, Maestro (UK Domestic), and
Maestro (International).
On Cardnet International, CyberSource supports enhanced
authorization reversals; therefore, CyberSource sends the
processor extra data in the authorization reversal request.
You do not need to process or monitor the extra data.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
RBS WorldPay Atlanta Card types supported for full authorization reversals: Visa,
Mastercard, American Express, and Discover.
Rede Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Diners Club, JCB, Elo,
Hipercard

Credit Card Services Using the Simple Order API | September 2019 56
 Chapter 2 Payment Card Processing

Table 17 Processors That Support Full Authorization Reversals (Continued)

Processor Card Types and Notes

SIX Card types supported for full authorization reversals: Visa,
Mastercard, Discover, Diners Club, JCB,
Maestro (International), Maestro (UK Domestic),
China UnionPay, Visa Electron.
Software Express Card types supported for full authorization reversals: Visa,
Mastercard
Streamline Requirement: you are responsible for complying with the
processor’s specific requirements for full authorization
reversals. Contact the processor for more information.
CyberSource supports enhanced authorization reversals on
this processor; therefore, CyberSource sends the processor
extra data in the authorization reversal request. You do not
need to process or monitor the extra data.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
TSYS Acquiring Solutions Card types supported for full authorization reversals: Visa,
Mastercard, American Express, Discover, Diners Club, and
JCB.
Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.
Worldpay VAP Card types supported for full authorization reversals: Visa,
Mastercard, Discover, Diners Club, and JCB.
Worldpay VAP was previously
called Litle. Important ARAV is supported. See "Authorization
Reversal after Void (ARAV)," page 59.

Creating a Full Authorization Reversal Request

A full authorization reversal is a follow-on transaction that uses the request ID returned
from a previous authorization. The request ID links the full authorization reversal to the
authorization. CyberSource uses the request ID to look up the customer’s billing and
account information from the original authorization, so you are not required to include
those fields in your full authorization reversal request.

For American Express aggregator transactions on CtV, CyberSource retrieves

the aggregator information for the authorization that is being reversed.
Note

For information about requesting a follow-on service, see Getting Started with
CyberSource Advanced for the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 57
 Chapter 2 Payment Card Processing

To create a full authorization reversal request:

Step 1 Do not include any other CyberSource services in the request.

Step 2 Include the required fields in the request:

Table 18 Required Fields for Full Authorization Reversals

Field Notes
ccAuthReversalService_ Set to the request ID that was included in the authorization reply
authRequestID message.
ccAuthReversalService_run Set to true.
merchantID
merchantReferenceCode
paymentSolution Include this field only when using Visa Checkout or Visa Secure
Remote Commerce.
purchaseTotals_currency
purchaseTotals_ Either purchaseTotals_grandTotalAmount or item_#_
grandTotalAmount unitPrice must be included in the request.
vc_orderID Include this field only when using Visa Checkout or Visa Secure
Remote Commerce.

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Optional request fields
 Reply fields

Step 3 Make sure that the amount of the reversal is the same as the amount that was authorized:

 You cannot partially reverse an authorization; you can reverse an authorization only
for its full amount.

 When you use a debit card or prepaid card and only a partial amount was approved,
the amount of the reversal must be the amount that was authorized, not the amount
that was requested.

Credit Card Services Using the Simple Order API | September 2019 58
 Chapter 2 Payment Card Processing

Authorization Reversals for Single-Message

Processing
Processors:
 CyberSource through VisaNet—National Commercial Bank (NCB) is the only acquirer
that supports single-message processing.

Card Types:
 On CyberSource through VisaNet—all mada card types as described in "mada Debit
Cards," page 24.

Authorization reversals are not supported for least-cost routing and single-
message processing on Worldpay VAP. To process an aborted transaction or
Note a return, request the credit service. See "Crediting a Payment," page 78.

An authorization reversal returns funds to the customer, either by releasing the hold on the
customer’s funds or by transferring money from your account to the customer’s account. If
the authorization reversal request is not successful, perform a credit to refund the money
to the customer.

Authorization Reversal after Void (ARAV)

Processors:
 American Express Direct
 Barclays
 Chase Paymentech Solutions
 Comercio Latino
 Credit Mutuel-CIC
 CyberSource through VisaNet
 FDC Compass
 FDC Germany
 FDC Nashville Global
 FDMS Nashville
 FDMS South
 GPN
 HBoS
 HSBC: HSBC is the CyberSource name for HSBC U.K.Lloyds-OmniPay
 LloydsTSB Cardnet

Credit Card Services Using the Simple Order API | September 2019 59
 Chapter 2 Payment Card Processing

 OmniPay Direct. The supported acquirers are:

 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 SIX
 Streamline
 TSYS Acquiring Solutions
 Worldpay VAP—Worldpay VAP was previously called Litle.

This feature enables you to reverse an authorization after you void the associated capture.

This functionality enables you to meet the Visa mandate requirements to

reverse unused authorizations, and it benefits the customer by releasing the
Important hold on unused credit card funds.

To reverse an authorization after a void:

Step 1 Void a capture. See "Voiding a Capture or Credit," page 85.

Step 2 Reverse the authorization associated with the capture. See "Reversing an Authorization,"
page 52.

You might need to perform additional steps if you performed multiple partial
captures for the authorization. To learn whether your processor supports
Note multiple partial captures, see "Multiple Partial Captures," page 71. For
information about multiple captures and ARAV, see "Multiple Partial Captures
and Authorization Reversal after Void," page 73.

Automatic ARAV
Processors:
 Credit Mutuel-CIC
 CyberSource through VisaNet
 SIX

Normally, you must send an authorization reversal request after you void the associated
capture. With automatic ARAV, CyberSource automatically reverses the authorization
after you void the associated capture. To enable automatic ARAV, contact CyberSource
Customer Support to have your account configured for this feature.

Credit Card Services Using the Simple Order API | September 2019 60
 Chapter 2 Payment Card Processing

Capturing an Authorization
CyberSource supports captures for all processors.

When you are ready to fulfill a customer’s order and transfer funds from the customer’s
bank to your bank, capture the authorization for that order.

When fulfilling only part of a customer’s order, do not capture the full amount of the
authorization. Capture only the cost of the items that you ship. When you ship the
remaining items, request a new authorization, and then capture the new authorization.

Captures
Unlike authorizations, a capture does not happen in real time. All of the capture requests
for a day are placed in a batch file and sent to the processor. In most cases, the batch is
settled at night. It usually takes two to four days for your acquiring bank to deposit funds in
your merchant bank account.

The following figure shows the steps that occur when you request a capture or credit.

Figure 2 Processing a Capture or Credit

1 You send a request for capture or credit over a secure Internet connection.

2 CyberSource validates the order information then stores the capture or credit request in a
batch file.

3 After midnight, CyberSource sends the batch file to your payment processor.

Credit Card Services Using the Simple Order API | September 2019 61
 Chapter 2 Payment Card Processing

4 The processor settles the capture or credit request and transfers funds to the appropriate
bank account.

The processor does not notify CyberSource when a transaction is declined. To

ensure that all captures and credits are processed, reconcile your system’s
Note reports with the reports from your processor. See Getting Started with
CyberSource Advanced for the Simple Order API for information about
reconciliation.

Due to the potential delay between authorization and capture, the authorization might
expire with the issuing bank before you request capture. Most authorizations expire within
five to seven days. If an authorization expires with the issuing bank before you request the
capture, your bank or processor might require you to resubmit an authorization request
and include a request for capture in the same message.

CyberSource is not informed by the issuing bank when an authorization

expires. By default, the authorization remains in the CyberSource system for 60
Note days after the authorization date, even after it expires with the issuing bank.

Creating a Capture Request

A capture is a follow-on transaction that uses the request ID returned from a previous
authorization. The request ID links the capture to the authorization. CyberSource uses the
request ID to look up the customer’s billing and account information from the original
authorization, so you are not required to include those fields in your capture request.

For information about requesting a follow-on service, see Getting Started with
CyberSource Advanced for the Simple Order API.

For Atos, your request for a capture must also include the request token
returned from a previous authorization in addition to the request ID. Like the
Note request ID, the request token links the capture to the authorization. Send the
request token in the orderRequestToken field.

Credit Card Services Using the Simple Order API | September 2019 62
 Chapter 2 Payment Card Processing

To create a capture request:

Step 1 Do not include any of these services in the request:

 Full authorization reversal (ccAuthReversalService)

 Credit (ccCreditService)

 Services for other payment methods, such as electronic checks or PayPal

 Risk update (riskUpdateService)

 Advanced fraud screen (afsService)

Step 2 Include the required fields in the request:

Table 19 Required Fields for Captures

Field Notes
ccCaptureService_run Set to true.
ccCaptureService_ Set to the request ID that was included in the authorization reply
authRequestID message. Optional when ccAuthService and ccCaptureService
are in the same request.
merchantID
merchantReferenceCode
orderRequestToken Required only for Atos.
paymentSolution Include this field only when using Visa Checkout or Visa Secure
Remote Commerce.
purchaseTotals_currency
purchaseTotals_ Either purchaseTotals_grandTotalAmount or item_#_unitPrice
grandTotalAmount must be included in the request.
vc_orderID Include this field only when using Visa Checkout or Visa Secure
Remote Commerce.

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Optional request fields
 Reply fields

Step 3 If needed, modify the request to accommodate additional information for your processor.
See Table 20, "Capture Information for Specific Processors," on page 64.

For Cartes Bancaires cards, your capture request cannot be for less than 0.99
EUR.
Note

Credit Card Services Using the Simple Order API | September 2019 63
 Chapter 2 Payment Card Processing

Step 4 Include optional features in the request.

There are several optional features that you can include in your request. These features
are described in Chapter 5, "Optional Features," on page 116.

Capture Information for Specific Processors

The following table provides additional information about captures for some processors.

Table 20 Capture Information for Specific Processors

Payment Processor Capture Information

AIBMS Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
American Express Direct For USD, American Express Direct limits authorization and
capture amounts to 9,999,999.00. For other currencies, the
maximum amount depends on the currency. Contact American
Express for the maximum amounts for the currencies that you
are using. Regardless of exponent or currency, the maximum
number of digits for the amount value is 12 digits.
Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.
Asia, Middle East, and Africa The Asia, Middle East, and Africa Gateway limits authorization
Gateway and capture amounts to four bytes, which is 2147483647.
Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Automatic capture requirement: certain acquirers that are
connected to the Asia, Middle East, and Africa Gateway require
automatic captures. See "Automatic Captures," page 40.
Contact your CyberSource Customer Support representative to
learn whether your acquirer uses standard or automatic
captures.
Atos Atos limits authorization, capture, and credit amounts to 12
digits; therefore, the maximum amount is 999999999999.
Important Authorizations time out after 5 days, 20 hours, and
30 minutes. For Maestro (UK Domestic), when you submit a
capture request after 5 days, 20 hours, and 30 minutes, you
must reauthorize first. For all other card types, when you submit
a capture request after 5 days, 20 hours, and 30 minutes,
CyberSource tries to obtain a fresh authorization as described in
"Authorization Refresh," page 68.

Credit Card Services Using the Simple Order API | September 2019 64
 Chapter 2 Payment Card Processing

Table 20 Capture Information for Specific Processors (Continued)

Payment Processor Capture Information

Barclays Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Special request fields for multiple partial captures are required.
See "Special Request Fields for Multiple Partial Captures,"
page 72.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.
Chase Paymentech Solutions Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.
Cielo Cielo supports standard captures and automatic captures.
 By default, your CyberSource account is configured to
support standard capture processing.
 For an Aura Card transaction, you must set the authorization
type to AUTOCAPTURE. See "Automatic Captures," page 40.
Comercio Latino Comercio Latino supports standard captures and automatic
captures. See "Automatic Captures," page 40.
Credit Mutuel-CIC Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
CyberSource Latin American Automatic capture requirements: payment card company rules
Processing generally specify that you must not capture a payment until you
have shipped the products to the customer. However, with
CyberSource Latin American Processing, for some countries
you are required to submit an automatic capture. See
"Automatic Captures," page 40. For other countries, you can
submit standard authorization and capture requests. Contact
CyberSource Customer Support for each country’s
requirements.
For transactions in Brazil:
 You must request the follow-on capture within five days of the
authorization request.
 The capture amount can be less than the authorization
amount.
 You can request only one capture per authorization.
With CyberSource Latin American Processing, it takes 31 days
for the funds to be deposited in your merchant bank account.

Note CyberSource Latin American Processing is the name of a

specific processing connection that CyberSource supports. In
the CyberSource API documentation, CyberSource Latin
American Processing does not refer to the general topic of
processing in Latin America.

Credit Card Services Using the Simple Order API | September 2019 65
 Chapter 2 Payment Card Processing

Table 20 Capture Information for Specific Processors (Continued)

Payment Processor Capture Information

CyberSource through CyberSource through VisaNet limits authorization and capture
VisaNet amounts to 12 digits; therefore, the maximum amount is
999999999999.
Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
Elavon Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Elavon Americas Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
FDC Compass Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Special request fields for multiple partial captures are
recommended. See "Special Request Fields for Multiple Partial
Captures," page 72.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.
FDC Germany Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
FDC Nashville Global CyberSource always provides merchant descriptor information
to the processor for you for all capture and credit transactions.
See "Merchant Descriptors," page 169.
Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
FDMS Nashville Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
FDMS South Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
GPN GPN limits the authorization, capture, and credit amounts to 10
digits.
Split shipments are supported. See "Split Shipments," page 220.
Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
HBoS Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
HSBC Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
HSBC is the CyberSource
name for HSBC U.K. Important This feature has restrictions. Contact CyberSource
Customer Support for details.

Credit Card Services Using the Simple Order API | September 2019 66
 Chapter 2 Payment Card Processing

Table 20 Capture Information for Specific Processors (Continued)

Payment Processor Capture Information

Ingenico ePayments With Cartes Bancaires, the authorization and capture amount
must be 0.99 EUR or more.
Ingenico ePayments was
previously called Global Captures for cards using Ingenico ePayments are not batched.
Collect. CyberSource submits these captures immediately to Ingenico
ePayments when they are received.
JCN Gateway Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Lloyds-OmniPay Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
LloydsTSB Cardnet Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.
Moneris Moneris limits authorization and capture amounts to nine digits;
therefore, the maximum amount is 9999999.99.
OmniPay Direct Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Special request fields for multiple partial captures are
recommended. See "Special Request Fields for Multiple Partial
Captures," page 72.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.
OmniPay-Ireland Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Important This feature has restrictions. Contact CyberSource
Customer Support for details.
Streamline Important ARAV is supported. See "Authorization Reversal
after Void (ARAV)," page 59.
SIX A request for a capture must include an authorization request.
TSYS Acquiring Solutions Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Special request fields for multiple partial captures are required.
See "Special Request Fields for Multiple Partial Captures,"
page 72.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.

Credit Card Services Using the Simple Order API | September 2019 67
 Chapter 2 Payment Card Processing

Table 20 Capture Information for Specific Processors (Continued)

Payment Processor Capture Information

Worldpay VAP Worldpay VAP limits authorization and capture amounts to eight
digits; therefore, the maximum amount is 99999999.
Worldpay VAP was
previously called Litle. Multiple partial captures are supported. See "Multiple Partial
Captures," page 71.
Important ARAV is supported. See "Multiple Partial Captures
and Authorization Reversal after Void," page 73.

Capture Features

Authorization Refresh

On CyberSource through VisaNet and GPN, authorization refresh is performed

as part of interchange optimization. See "Interchange Optimization," page 70.
Note

Processor:
 Atos

CyberSource provides authorization refresh functionality to Atos merchants for all card
types except Maestro (UK Domestic).

When a capture request occurs more than 5 days, 20 hours, and 30 minutes after the date
of the original authorization, CyberSource tries to obtain a fresh authorization for the
capture amount by performing a system-generated authorization using the payment data
from the original authorization.

Payer authentication data and CVN data are not included in system-generated
authorizations. Regardless of whether or not you included payer authentication data in
your original authorization request, you will not receive payer authentication protection for
a system-generated authorization.

If the system-generated authorization is successful, CyberSource submits the capture

request with the information from the new authorization. If the system-generated
authorization is not successful, CyberSource submits the capture request with the
information from the original authorization.

The system-generated authorization is linked to the original authorization in the Business

Center and in reports. The subsequent capture is linked to both authorizations in the
Business Center and in reports through the request IDs as with any capture.

Credit Card Services Using the Simple Order API | September 2019 68
 Chapter 2 Payment Card Processing

Automatic Partial Authorization Reversals

Processors and card types:
See the following table.

Table 21 Processors That Support Automatic Partial

Authorization Reversals

Processor Card Types

Barclays Visa, Mastercard, JCB, Maestro (International),
Maestro (UK Domestic)
Chase Paymentech Solutions1 Visa, Mastercard
Credit Mutuel-CIC Visa, Mastercard, Cartes Bancaires
CyberSource through VisaNet Visa, Mastercard
Elavon Americas Visa, Mastercard, American Express, JCB, Diners Club,
Discover, China UnionPay
FDC Compass1 Visa, Mastercard
FDC Nashville Global Visa, Mastercard, Discover, Diners Club, China UnionPay,
JCB (US Domestic)2
FDMS Nashville Visa, Mastercard, Discover, Diners Club,
JCB (US Domestic)2
FDMS South Visa, Mastercard, Discover, JCB (US Domestic)2
GPN Visa, Mastercard
On GPN, automatic partial authorization reversal is
performed as part of interchange optimization, which is
described in "Interchange Optimization," page 70.
OmniPay Direct Cardnet International: Visa
OmniPay-Ireland Visa
OmniPay-Ireland is the
CyberSource name for HSBC
International.
TSYS Acquiring Solutions Visa, Mastercard, Discover, Diners Club, JCB
1 The processor performs an automatic partial authorization reversal when there is an interchange benefit.
The processor does not allow CyberSource to perform this functionality.
2 For JCB cards, “US Domestic” means that the currency is USD and your location is the U.S., Puerto
Rico, Guam, U.S. Virgin Islands, or Northern Mariana Islands.

In addition to credit cards, automatic partial authorization reversals are supported for:

 Debit cards and prepaid cards: see Chapter 4, "Features for Debit Cards and Prepaid
Cards," on page 105.

 Quasi-cash: see "Quasi-Cash," page 205.

Credit Card Services Using the Simple Order API | September 2019 69
 Chapter 2 Payment Card Processing

If the capture amount is less than the authorization amount, CyberSource automatically
performs a partial authorization reversal before it sends the capture request to the
processor. The results of a successful partial authorization reversal are:

 The capture amount matches the new authorization amount at the payment card
company.

 The hold on the unused credit card funds might be released. The issuing bank
decides whether or not to release the hold on unused funds.

Not all issuers act on a request for a partial authorization reversal.

Therefore, CyberSource cannot guarantee that the funds will be released.
Note

Interchange Optimization
Processors:
 CyberSource through VisaNet: Visa, Mastercard

Interchange optimization is not available for Mastercard transactions in the

IDR currency on CyberSource through VisaNet.
Important

 GPN acquiring merchants: Visa, Mastercard

Interchange optimization helps you reduce your interchange fees. Interchange

optimization consists of:

 Automatic authorization refresh: When the capture request occurs more than six days
after the date of the original authorization, CyberSource automatically obtains a fresh
authorization for the capture amount.

On GPN, the fresh authorization uses the same authorization indicator as the original
authorization. For more information, see "Final Authorization Indicator," page 138.

 Automatic partial authorization reversal: If the capture does not need a fresh
authorization but the capture amount is less than the authorization amount,
CyberSource automatically performs a partial authorization reversal which releases
the hold on unused credit card funds and ensures that the settlement amount matches
the authorization amount.

Interchange optimization does not work for card-present transactions.

Note

To enable interchange optimization, contact CyberSource Customer Support to have your

account configured for this feature.

Credit Card Services Using the Simple Order API | September 2019 70
 Chapter 2 Payment Card Processing

Multiple Partial Captures

Processors:
 AIBMS

 American Express Direct

 Asia, Middle East, and Africa Gateway

 Barclays

 Chase Paymentech Solutions

 CyberSource through VisaNet: contact CyberSource Customer Support to have your

account enabled for this feature. Your account can be enabled for multiple partial
captures or split shipments; it cannot be enabled for both features.

 Elavon

 Elavon Americas

 FDC Compass

 FDC Nashville Global: multiple partial captures are supported only for card-not-
present transactions; they are not supported for card-present transactions.

 FDMS Nashville: multiple partial captures are supported only for card-not-present
transactions; they are not supported for card-present transactions.

 HSBC: HSBC is the CyberSource name for HSBC U.K. To enable multiple partial
captures on HSBC, contact CyberSource Customer Support to have your account
configured for this feature.

 JCN Gateway

 LloydsTSB Cardnet: to enable multiple partial captures on LloydsTSB Cardnet,

contact CyberSource Customer Support to have your account configured for this
feature.

 OmniPay Direct. The supported acquirers are:

 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 OmniPay-Ireland: to enable multiple partial captures on OmniPay-Ireland, contact

CyberSource Customer Support to have your account configured for this feature.

Credit Card Services Using the Simple Order API | September 2019 71
 Chapter 2 Payment Card Processing

 Streamline. See "Multiple Partial Captures on Streamline," page 73.

 TSYS Acquiring Solutions

 Worldpay VAP—Worldpay VAP was previously called Litle.

Multiple partial captures and split shipments are not the same feature.
 The multiple partial captures feature is provided by the processor. This
Note feature enables you to request multiple partial captures for one
authorization.
 The split shipment feature is provided by CyberSource. This feature
supports three different scenarios: multiple authorizations, multiple
captures, and multiple authorizations with multiple captures. For more
information, see "Split Shipments," page 220.

This feature enables you to request multiple partial captures for one authorization. You
must ensure that the total amount of all the captures does not exceed the authorized
amount.

Special Request Fields for Multiple Partial Captures

Processors:
 Barclays. The special request fields are required.

 FDC Compass. To avoid a downgrade for a Visa transaction, the special request fields
are required. For other card types, CyberSource strongly recommends that you
include the special request fields.

 FDC Nashville Global. The special request fields are required for all card types:

 For Visa and Mastercard, CyberSource sends the values for the special request
fields to the processor.

 For all card types, CyberSource uses the values for the special request fields to
determine whether to initiate an automatic partial authorization reversal as
described in "Automatic Partial Authorization Reversals," page 69.

 FDMS Nashville. The special request fields are required for Visa and Mastercard
transactions. They are not supported for other card types.

Credit Card Services Using the Simple Order API | September 2019 72
 Chapter 2 Payment Card Processing

 OmniPay Direct. CyberSource strongly recommends that you include the special
request fields. The supported acquirers are:
 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 TSYS Acquiring Solutions. The special request fields are required.

Include the following special request fields in each capture request when you are
requesting multiple partial captures:
 ccCaptureService_sequence
 ccCaptureService_totalCount

When you do not know the total number of captures that you are going to request, set the
capture total count to an estimated value or 99 for all capture requests except the final
one. For the final capture request, set the capture total count and the capture sequence to
the same value.

Multiple Partial Captures on Streamline

Streamline might consider a partial capture to be a duplicate and reject the transaction
when one or more of the following is the same for a merchant ID. You must ensure that
you do not submit duplicate transaction information when using multiple partial captures,
otherwise Streamline may reject the transaction.
 transaction date
 card_accountNumber
 merchantReferenceCode
 purchaseTotals_grandTotalAmount

Multiple Partial Captures and Authorization Reversal after Void

Processors:
 American Express Direct
 Barclays
 Chase Paymentech Solutions
 CyberSource through VisaNet
 FDC Compass
 FDC Nashville Global
 FDMS Nashville
 LloydsTSB Cardnet

Credit Card Services Using the Simple Order API | September 2019 73
 Chapter 2 Payment Card Processing

 OmniPay Direct. The supported acquirers are:

 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 TSYS Acquiring Solutions

 Worldpay VAP—Worldpay VAP was previously called Litle.

This feature enables you to reverse an authorization after you void the associated capture.

This functionality enables you to meet the Visa mandate requirements to

reverse unused authorizations, and it benefits the customer by releasing the
Important hold on unused credit card funds.

For an authorization that has multiple associated captures:

 If you reverse the authorization, CyberSource declines subsequent capture requests.

 If you void only one of the multiple captures, CyberSource declines subsequent
authorization reversal requests.

 If you void all of the multiple captures, you can reverse the authorization.

To reverse an authorization after a void for multiple captures:

Step 1 Void each capture associated with the authorization. See "Voiding a Capture or Credit,"
page 85.

Step 2 Reverse the authorization. See "Reversing an Authorization," page 52.

Credit Card Services Using the Simple Order API | September 2019 74
 Chapter 2 Payment Card Processing

Performing a Sale
A sale is a bundled authorization and capture. Some processors and acquirers require a
sale transaction instead of separate authorization and capture requests. For other
processors and acquirers, you can request a sale instead of a separate authorization and
capture if there is no delay between taking a customer’s order and shipping the goods. A
sale is typically used for electronic goods and for services that you can turn on
immediately.

Dual-Message Processing
To perform a sale, request the authorization and capture services at the same time.
Include the request fields that are required for the authorization. No additional fields are
required for the capture.

If the authorization is successful, CyberSource processes the capture immediately and the
reply message includes results for the authorization and for the capture. If the
authorization is declined, CyberSource does not process the capture and the reply
message includes results only for the authorization.

For debit cards and prepaid cards, the issuing bank can approve a partial amount if the
balance on the card is less than the requested authorization amount and if the transaction
is enabled for partial authorization. When this happens, CyberSource does not process
the capture. However, you can submit a capture request for the approved amount. For
details about partial authorizations and for a list of the processors and card types
supported for partial authorizations, see "Partial Authorizations," page 105.

For a limited number of processors and card types, partial authorizations are
supported for credit cards in addition to debit cards and prepaid cards. See
Note "Partial Authorizations," page 105.

For details about authorizations and captures, see "Authorizing a Payment," page 38, and
"Capturing an Authorization," page 61.

Credit Card Services Using the Simple Order API | September 2019 75
 Chapter 2 Payment Card Processing

Single-Message Processing

See also "Least-Cost Routing (LCR)," page 164.

Note

Processors:
 CyberSource through VisaNet—National Commercial Bank (NCB) is the only acquirer
that supports single-message processing.
 RuPay

Card Types:
 All mada card types as described in "mada Debit Cards," page 24.
 RuPay

There are important differences between single-message processing and dual-

message processing:
Important  With single-message processing, an authorization+capture request
results in a full-financial transaction, which moves funds immediately.

 With single-message processing, the capture amount and authorization

amount are the same.

 Several services and features are not supported for single-message

processing because they are not applicable or could create reconciliation
problems. See "Unsupported Features," page 78.

To perform a sale using SMP, request the authorization and capture services at the same
time. Include the request fields that are required for the authorization. No additional fields
are required for the capture. On CyberSource through VisaNet, SAMA sends a full-
financial transaction request to the issuer.

The reply message that CyberSource sends to you includes authorization and capture
results. The authorization amount and capture amount are the same.

For details about authorizations and captures, see "Authorizing a Payment," page 38, and
"Capturing an Authorization," page 61.

Partial Authorizations
For SMP, partial authorizations are supported only on CyberSource through VisaNet. If the
transaction is enabled for partial authorization, the processor can process a partial amount
instead of the entire requested amount. For details about partial authorizations, see
"Partial Authorizations," page 105.

Credit Card Services Using the Simple Order API | September 2019 76
 Chapter 2 Payment Card Processing

Supported Features on CyberSource through VisaNet

The following features are supported for single-message processing:

 AVS. See "Address Verification System (AVS)," page 88.

 Balance responses. See "Balance Responses," page 111.

 Credits. See "Crediting a Payment," page 78.

 CVN. See "Card Verification Numbers (CVNs)," page 97.

 Debit cards. See Chapter 4, "Features for Debit Cards and Prepaid Cards," on
page 105.

 Final authorization indicator. See "Final Authorization Indicator," page 138.

 Full authorization reversals. See "Authorization Reversals for Single-Message

Processing," page 59.

 Merchant descriptors. See Merchant Descriptors Using the Simple Order API.

 Merchant-initiated reversals and voids. See "Merchant-Initiated Reversals and Voids,"

page 170.

 Merchant-initiated transactions. See "Merchant-Initiated Transactions (MITs) and

Credentials-on-File (COF) Transactions," page 173.

 Payer authentication. See "Payer Authentication," page 186.

 Prepaid cards. See Chapter 4, "Features for Debit Cards and Prepaid Cards," on
page 105.

Supported Features on RuPay

The following features are supported for single-message processing:
 Credits. See "Crediting a Payment," page 78.
 CVN. See "Card Verification Numbers (CVNs)," page 97.
 Payer authentication. See "Payer Authentication," page 186.

Credit Card Services Using the Simple Order API | September 2019 77
 Chapter 2 Payment Card Processing

Unsupported Features
The following features are not supported for single-message processing:
 Authorization reversal after void
 Automatic authorization reversal after void
 Automatic partial authorization reversals
 Interchange optimization
 Multiple partial captures
 Split shipments
 Stand-alone authorizations
 Stand-alone captures
 Verbal authorizations
 Voids

Crediting a Payment
CyberSource supports credits for all processors.

When your request for a credit is successful, the issuing bank for the payment card takes
money out of your merchant bank account and returns it to the customer. It usually takes
two to four days for your acquiring bank to transfer funds from your merchant bank
account.

Carefully control access to this service to prevent unauthorized credits. Do not

request this service directly from your customer interface. Instead, incorporate
Warning this service as part of your customer service process.

Credit requests are batched in the same manner as captures. See "Captures," page 61.

Credit Card Services Using the Simple Order API | September 2019 78
 Chapter 2 Payment Card Processing

Types of Credits
A follow-on credit is linked to a capture in the CyberSource system. You can request
multiple follow-on credits against a single capture. On CyberSource through VisaNet and
SIX, you must request a follow-on credit within 180 days of the authorization. For all other
processors, you must request a follow-on credit within 60 days of the authorization.

On Atos, your request for a follow-on credit must also include the request token
returned from a previous capture request in addition to the request ID. Like the
Note request ID, the request token links the follow-on credit to the capture. Send the
request token in the orderRequestToken field.

When you combine a request for a follow-on credit with a request for another
service, such as the tax calculation service, you must provide the customer’s
Important billing and account information.

A stand-alone credit is not linked to a capture. There is no time limit for requesting stand-
alone credits. Instead of sending the request ID field in the credit request, the request
must include the fields for the customer’s billing and account information.

For stand-alone credits, CyberSource does not validate billTo_postalCode or

shipTo_postalCode.
Note

Creating a Credit Request

A follow-on credit uses the request ID returned from a previous capture to link the credit to
the capture. CyberSource uses the request ID to look up the customer’s billing and
account information from the original authorization, so you are not required to include
those fields in your credit request. To perform multiple partial follow-on credits, send the
same request ID in each follow-on credit request.

For information about requesting a follow-on service, see Getting Started with
CyberSource Advanced for the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 79
 Chapter 2 Payment Card Processing

To create a credit request:

Step 1 Do not include any of these services in the request:

 Any other credit card services (ccAuthService, ccAuthReversalService, or

ccCaptureService)

 Services for other payment methods, such as electronic checks or PayPal

 Risk update (riskUpdateService)

Step 2 Include the required fields in the request:

Table 22 Required Fields for Credits

Field Notes
ccCreditService_ For a follow-on credit, set to the request ID that was included in
captureRequestID the capture reply message. Not used for a stand-alone credit.
ccCreditService_ Required only for stand-along credits on Chase Paymentech
commerceIndicator Solutions.
ccCreditService_run Set to true.
merchantID
merchantReferenceCode
paymentSolution Include this field only when using Visa Checkout or Visa Secure
Remote Commerce.
purchaseTotals_currency
purchaseTotals_ Either purchaseTotals_grandTotalAmount or item_#_unitPrice
grandTotalAmount must be included in the request.
vc_orderID Include this field only when using Visa Checkout or Visa Secure
Remote Commerce.

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Optional request fields
 Reply fields

Credit Card Services Using the Simple Order API | September 2019 80
 Chapter 2 Payment Card Processing

Step 3 For a stand-alone credit, include additional required fields:

Table 23 Additional Required Fields for Stand-Alone Credits

Field Notes
billTo_city1
billTo_country1
billTo_email1
billTo_firstName1
billTo_lastName1
billTo_postalCode1 Required only for transactions in the U.S. and Canada.
1
billTo_state Required only for transactions in the U.S. and Canada.
1
billTo_street1
card_accountNumber
card_cardType Required for certain card types. CyberSource strongly
recommends that you send the card type even if it is optional for
your processor. Omitting the card type can cause the transaction
to be processed with the wrong card type.
card_expirationMonth1
card_expirationYear1
1 This field is optional if your CyberSource account is configured for relaxed requirements for address data
and expiration date. See "Relaxed Requirements for Address Data and Expiration Date," page 91.
Important It is your responsibility to determine whether a field is required for the transaction you are
requesting.

Step 4 If needed, modify the request to accommodate additional information for your processor.
See "Credit Information for Specific Processors," page 82.

Step 5 Include optional features in the request. See Chapter 5, "Optional Features," on page 116.

Credit Card Services Using the Simple Order API | September 2019 81
 Chapter 2 Payment Card Processing

Credit Information for Specific Processors

The following table provides additional information about credits for some processors.

Table 24 Credit Information for Specific Processors

Payment Processor Credit Information

Atos Atos supports only follow-on credits. Stand-alone credits are
not supported. The credit amount cannot exceed the capture
amount.
Atos limits authorization, capture, and credit amounts to 12
digits; therefore, the maximum amount is 999999999999.
A credit cannot be processed on the same day as the
capture that is being credited. You must wait until the day
after the capture before requesting a credit.
Cielo Cielo does not support stand-alone credits.
CyberSource recommends that you do not submit a follow-
on credit request on the same day as the capture that is
being credited.
Comercio Latino Comercio Latino does not support stand-alone credits.
A credit cannot be processed on the same day as the
capture that is being credited. You must wait until the day
after the capture before requesting a credit.
Multiple partial credits cannot exceed the original
authorization amount.
CyberSource declines credit requests if the associated
capture was not successful.
Credits must be processed within 180 days of the original
authorization.
On American Express, multiple partial credits are not
supported.
CyberSource Latin American CyberSource Latin American Processing supports only
Processing follow-on credits. Stand-alone credits are not supported. The
60-day limit for follow-on credits does not apply to
CyberSource Latin American Processing: you can request a
follow-on credit more than 60 days after the original charge.
CyberSource Latin American Processing does not support
the credit service for Aura Card and Hipercard. You must
make manual refunds for these card types.

Note CyberSource Latin American Processing is the name

of a specific processing connection that CyberSource
supports. In the CyberSource API documentation,
CyberSource Latin American Processing does not refer to
the general topic of processing in Latin America.

Credit Card Services Using the Simple Order API | September 2019 82
 Chapter 2 Payment Card Processing

Table 24 Credit Information for Specific Processors (Continued)

Payment Processor Credit Information

CyberSource through VisaNet CyberSource recommends that you do not submit a follow-
on credit request on the same day as the capture that is
being credited.
FDC Nashville Global CyberSource always provides information to the processor
for you for all capture and credit transactions. See "Merchant
Descriptors," page 169.
Getnet Stand-alone credits are not supported.
For follow-on credits:
 A partial credit cannot be processed on the same day as
the capture that is being credited. You must wait until the
day after the capture before requesting a partial credit.
 A credit for the full capture amount can be processed on
the same day as the capture.
GPN GPN limits the authorization, capture, and credit amounts to
10 digits.
Ingenico ePayments With Ingenico ePayments, you can process only one follow-
on credit against a specific captured authorization each day.
Ingenico ePayments was
For example, if you want to process a follow-on credit of
previously called Global Collect.
15.00 against an original capture of 50.00, and then later you
want to process a follow-on credit of 35.00 against the same
capture, you must request the two credits on two separate
days.
Before performing stand-alone credits with Ingenico
ePayments, you must contact CyberSource Customer
Support.
Credits for cards using Ingenico ePayments are not batched.
CyberSource submits these captures immediately to
Ingenico ePayments when they are received.
JCN Gateway JCN Gateway supports stand-alone credits. However, when
a request for a stand-alone credit is made, most acquirers
make inquiries about the purpose of such a request.
CyberSource recommends using follow-on credits instead of
stand-alone credits whenever possible.
RBS WorldPay Atlanta Follow-on credits for verbal authorizations are not supported.
You must process these refunds as stand-alone refunds.
Rede Stand-alone credits are not supported.
For follow-on credits:
 A partial credit cannot be processed on the same day as
the capture that is being credited. You must wait until the
day after the capture before requesting a partial credit.
 A credit for the full capture amount can be processed on
the same day as the capture.

Credit Card Services Using the Simple Order API | September 2019 83
 Chapter 2 Payment Card Processing

Table 24 Credit Information for Specific Processors (Continued)

Payment Processor Credit Information

RuPay For a single credit, the credit amount cannot exceed the
capture amount. For multiple partial credits, the total credit
amount cannot exceed the capture amount.
SIX A credit cannot be processed on the same day as the
capture that is being credited. You must wait until the day
after the capture before requesting a credit.
Worldpay VAP For a follow-on credit to be successfully processed, the
capture that is being credited must have been processed
Worldpay VAP was previously
successfully. To ensure that the capture is processed before
called Litle.
the follow-on credit request is received, do not batch the
follow-on credit on the same day as the capture.
If the capture has not been processed yet, CyberSource
sends this error message: The follow-on credit
cannot be processed because the capture
transaction has not been processed yet.
If the capture has been processed but was not successful,
CyberSource sends this error message: The follow-on
credit cannot be processed because the
capture transaction failed.

Credit Authorizations
Processor:
 CyberSource through VisaNet

A credit authorization authenticates the card and customer. If you are located in the U.S.
or Canada, CyberSource automatically authorizes every credit request. If you are not
located in the U.S. or Canada, contact CyberSource Customer Support to enable credit
authorizations for your account.

When you use the Simple Order API in XML format, you must use version
1.151 or later of the XML schema to receive the following reply fields.
Note

The following fields are included in the credit reply when CyberSource authorizes the
credit request:
 ccCreditReply_authorizationCode
 ccCreditReply_paymentNetworkTransactionID
 ccCreditReply_processorResponse

See Appendix A, "API Fields," on page 240 for descriptions of these fields.

Credit Card Services Using the Simple Order API | September 2019 84
 Chapter 2 Payment Card Processing

Voiding a Capture or Credit

CyberSource supports voids for all processors except:
 Atos
 Ingenico ePayments—Ingenico ePayments was previously called Global Collect.
 Lynk
 SIX

CyberSource Latin American Processing does not support voids for Aura Card
and Hipercard because transactions with these cards are captured
Note immediately.
CyberSource Latin American Processing is the name of a specific processing
connection that CyberSource supports. In the CyberSource API
documentation, CyberSource Latin American Processing does not refer to the
general topic of processing in Latin America. The information in this note is for
the specific processing connection called CyberSource Latin American
Processing. It is not for any other Latin American processors that
CyberSource supports.

Cielo and Comercio Latino are online gateways. Transactions are batched
every four minutes, which provides very little time for you to void a transaction.
Note

A void cancels a capture or credit request that you submitted to CyberSource. A

transaction can be voided only when CyberSource has not already submitted the capture
or credit request to your processor. CyberSource usually submits capture and credit
requests to your processor once a day, so your window for successfully voiding a capture
or credit request is small. CyberSource declines your void request when the capture or
credit request has already been sent to the processor.

You cannot perform a follow-on credit for a transaction that has been voided.

You cannot undo a void.

When you void a capture, a hold remains on the unused credit card funds. If you are not
going to re-capture the authorization as described in "Capture after Void," page 86, and if
your processor supports authorization reversal after void as described in "Authorization
Reversal after Void (ARAV)," page 59, CyberSource recommends that you request an
authorization reversal to release the hold on the unused credit card funds.

Credit Card Services Using the Simple Order API | September 2019 85
 Chapter 2 Payment Card Processing

Capture after Void

If your processor supports multiple captures, you can capture an authorization after you
void previous captures associated with the authorization. For example, you can follow
these steps:
1 Authorize a payment.
2 Capture the authorization.
3 Void the capture.
4 Capture the authorization again.

To learn whether your processor supports multiple captures, see "Multiple Partial
Captures," page 71.

On all other processors, when you void a transaction the transaction is at the end of its life
and cannot be the source of another follow-on capture or credit. For example, if you
authorize and capture a transaction, and then you void the capture, you cannot submit
another capture request that uses the authorization code or CyberSource request ID from
the original authorization. If you still want to capture that transaction, you must
re-authorize the transaction and capture the new authorization.

Creating a Void Request

A void is a follow-on transaction that uses the request ID returned from a capture or credit.
The request ID links the void to the service that is being voided. CyberSource uses the
request ID to look up the customer’s billing and account information from the capture or
credit, so you are not required to include those fields in your void request.

For information about requesting a follow-on service, see Getting Started with
CyberSource Advanced for the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 86
 Chapter 2 Payment Card Processing

To create a void request:

Step 1 Do not include any other CyberSource services in the request.

Step 2 Include the required fields in the request:

Table 25 Required Fields for Voids

Field Notes
merchantID
merchantReferenceCode
voidService_run Set to true.
voidService_voidRequestID Set to the request ID that was included in the capture or credit
reply message.

See Appendix A, "API Fields," on page 240 for:

 Detailed descriptions of these required request fields
 Reply fields

Credit Card Services Using the Simple Order API | September 2019 87
 CHAPTER
Authorization Features
3

You must support the authorization features that your processor supports.

Address Verification System (AVS)

AVS is supported only for cards issued in the U.K., the U.S., and Canada.

Note

Standard AVS
The following table lists the processors and card types for which CyberSource returns
standard AVS results.

Table 26 Processors That Support Standard AVS

Processors Payment Card Types

AIBMS Visa, Mastercard, Maestro (International), Maestro (UK Domestic)
American Express American Express
Brighton
You must contact CyberSource Customer Support to activate
standard AVS for American Express Brighton.
American Express American Express
Direct
You must contact CyberSource Customer Support to activate
standard AVS for American Express Direct.
Atos Visa and Mastercard: The billing country must be Great Britain.
Barclays Visa, Mastercard, Maestro (UK Domestic)
Chase Paymentech Visa, Mastercard, and American Express: The billing country must be
Solutions the U.S., Canada, or Great Britain.
Discover, Diners Club, and JCB: The billing country must be the U.S.

Credit Card Services Using the Simple Order API | September 2019 88
 Chapter 3 Authorization Features

Table 26 Processors That Support Standard AVS (Continued)

Processors Payment Card Types

Cielo Visa, Mastercard, American Express
Cielo can charge you additional fees for AVS processing. You must
contact Cielo and CyberSource Customer Support to activate
standard AVS for Cielo.
AVS is supported only for credit card transactions, not debit card
transactions.
AVS Codes for Cielo 3.0
See "AVS Codes for Cielo 3.0 and CyberSource Latin American
Processing," page 468.
Format for Raw AVS Codes for Cielo 1.5
The raw AVS response code is a concatenation of two values:
 The first value is the raw AVS code for the postal code.
 The second value is the raw AVS code for the street address.
If Cielo returns only one of the values, the missing value is indicated
by a question mark (?). Examples:
 ?N indicates that the raw AVS code for the postal code is missing
and that the raw AVS code for the street address is N.
 T? indicates that the raw AVS code for the postal code is T and that
the raw AVS code for the street address is missing.
Comercio Latino Visa, Mastercard, American Express, Discover, Diners Club, JCB,
Elo, Aura, Hipercard
Comercio Latino supports AVS input, but does not support AVS
response values.
Important Because a raw AVS response value is not available,
there is a potential impact to the Decision Manager services.
You must contact CyberSource Customer Support to activate
standard AVS for Comercio Latino.
Credit Mutuel-CIC Visa, Mastercard, Cartes Bancaires
CyberSource Latin Visa, Mastercard, American Express, Diners Club
American Processing
In Brazil, AVS is supported only for Redecard. To perform AVS for
Redecard in Brazil, you must provide the CPF (Cadastro de Pessoas
Fisicas) and the building number.
For AVS in Mexico, contact CyberSource Customer Support to have
your account enabled for this feature.

Note CyberSource Latin American Processing is the name of a

specific processing connection that CyberSource supports. In the
CyberSource API documentation, CyberSource Latin American
Processing does not refer to the general topic of processing in Latin
America.

Credit Card Services Using the Simple Order API | September 2019 89
 Chapter 3 Authorization Features

Table 26 Processors That Support Standard AVS (Continued)

Processors Payment Card Types

CyberSource through Visa, Mastercard, American Express, Diners Club, JCB, Discover,
VisaNet mada as described in "mada Debit Cards," page 24

Important When you populate billing street address 1 and billing

street address 2, CyberSource through VisaNet concatenates the two
values. If the concatenated value exceeds 40 characters,
CyberSource through VisaNet truncates the value at 40 characters
before sending it to Visa and the issuing bank. Truncating this value
affects AVS results and therefore might also affect risk decisions and
chargebacks.

Elavon Visa, Mastercard, Discover, Diners Club, Maestro (UK Domestic),

Maestro (International)
Your country and the billing country must be Great Britain. The
currency must be British pounds.
Elavon Americas Visa, Mastercard, American Express, JCB, Diners Club, Discover,
China UnionPay
FDC Compass Visa, Mastercard, and American Express: The billing country must be
the U.S., Canada, or Great Britain.
Discover and Diners Club: The billing country must be the U.S.
FDC Germany Visa, Mastercard
FDC Nashville Global Visa, Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic)
For JCB cards, “US Domestic” means that the currency is USD and
your location is the U.S., Puerto Rico, Guam, U.S. Virgin Islands, or
Northern Mariana Islands.
FDMS Nashville Visa, Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic)
For JCB cards, “US Domestic” means that the currency is USD and
your location is the U.S., Puerto Rico, Guam, U.S. Virgin Islands, or
Northern Mariana Islands.
FDMS South Visa, Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic)
For JCB cards, “US Domestic” means that the currency is USD and
your location is the U.S., Puerto Rico, Guam, U.S. Virgin Islands, or
Northern Mariana Islands.
GPN Visa, Mastercard, American Express, Discover, Diners Club, JCB
HBoS Visa, Mastercard
HSBC Visa, Mastercard, Maestro (UK Domestic), Maestro (International)
HSBC is the
CyberSource name for
HSBC U.K.
Lloyds-OmniPay Visa, Mastercard

Credit Card Services Using the Simple Order API | September 2019 90
 Chapter 3 Authorization Features

Table 26 Processors That Support Standard AVS (Continued)

Processors Payment Card Types

LloydsTSB Cardnet Visa, Mastercard
Lynk Visa, Mastercard, American Express, Discover, Diners Club
Moneris Visa, Mastercard, Discover
OmniPay Direct Bank of America Merchant Services: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
Cardnet International: Visa, Mastercard, Maestro (UK Domestic),
Maestro (International)
First Data Merchant Solutions (Europe): Visa, Mastercard, Discover,
Diners Club, Maestro (UK Domestic), Maestro (International)
Global Payments International Acquiring: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
OmniPay-Ireland Visa, Mastercard
OmniPay-Ireland is the
CyberSource name for
HSBC International.
RBS WorldPay Atlanta Visa, Mastercard, American Express, Discover, Diners Club
SIX Visa, Mastercard, Discover, Diners Club
Streamline Visa, Mastercard, Maestro (UK Domestic), Cartes Bancaires, Dankort
You must contact Streamline to activate standard AVS.
TSYS Acquiring Visa, Mastercard, American Express, Diners Club: The billing country
Solutions must be the U.S.
Worldpay VAP Visa, Mastercard, American Express, Discover, Diners Club, JCB
Worldpay VAP was
previously called Litle.

Relaxed Requirements for Address Data and Expiration Date

To enable relaxed requirements for address data and expiration date, contact
CyberSource Customer Support to have your account configured for this feature. For
details about relaxed requirements, see the Relaxed Requirements for Address Data and
Expiration Date page.

Credit Card Services Using the Simple Order API | September 2019 91
 Chapter 3 Authorization Features

Processing AVS Codes

When a processor supports AVS for a transaction’s card type, the issuing bank uses AVS
to confirm that the customer has provided the correct billing address. When a customer
provides incorrect information, the transaction might be fraudulent.

AVS occurs automatically with every authorization request. The authorization reply
includes the ccAuthReply_avsCode field, which contains the AVS code from the issuing
bank that indicates whether AVS matched the address and whether the address match
was partial or complete. See Appendix E, "AVS Codes," on page 468.

When AVS cannot verify the address, but the authorization is otherwise valid, you might
receive an AVS decline. You can capture authorizations that receive an AVS decline.
However, you must review these orders to ensure that they are legitimate. Settling
authorizations that fail the AVS check might have an impact on the fees charged by your
bank. Contact your bank for details about how AVS management might affect your
discount rate.

The ccAuthReply_avsCodeRaw field is the raw AVS code sent directly from the
processor. Do not use this value to handle the AVS response. Use the value only for
debugging purposes.

Controlling AVS Results

By default, only the AVS code N results in an AVS decline. You can change this behavior
by using the businessRules_declineAVSFlags field to specify a list of AVS codes that
should result in an AVS decline.

When you use businessRules_declineAVSFlags, you must include the value

N in the list if you want to receive declines for AVS code N.
Important

When your request includes the businessRules_ignoreAVSResult field set to true, you
receive no AVS declines, even when you use businessRules_declineAVSFlags.

Credit Card Services Using the Simple Order API | September 2019 92
 Chapter 3 Authorization Features

Enhanced AVS
Processor:
 American Express Direct

You must contact CyberSource Customer Support and American Express

to register for Enhanced AVS.
Note

Card type:
 American Express

Enhanced AVS consists of the standard AVS functionality plus verification of some
additional fields. The additional fields that are verified for Enhanced AVS are:
 billTo_firstName
 billTo_lastName

Automated Address Verification Plus (AAV+)

Processor:
 American Express Direct

You must contact CyberSource Customer Support and American Express

to register for AAV+.
Note

Card type:
 American Express

AAV+ consists of the Enhanced AVS functionality plus verification of some additional
fields. This service is intended for merchants who deliver physical goods to a different
address than the billing address. AAV+ verifies the additional fields only when the
standard and Enhanced AVS tests pass first. For information about Enhanced AVS, see
"Enhanced AVS," page 93.

Credit Card Services Using the Simple Order API | September 2019 93
 Chapter 3 Authorization Features

The additional fields that are verified for AAV+ are:

 shipTo_firstName
 shipTo_lastName
 shipTo_street1
 shipTo_country
 shipTo_postalCode
 shipTo_phoneNumber
 billTo_phoneNumber: American Express Direct only

For American Express Direct, when your account is enabled for AAV+ and
when you include the first name, last name, and phone number in your request
Note message, the reply message includes EV response codes for those fields. See
"Electronic Verification (EV)," page 94.

Electronic Verification (EV)

Processors:

 American Express Direct

 FDC Nashville Global

 TSYS Acquiring Solutions

 Worldpay VAP—Worldpay VAP was previously called Litle.

For EV, Worldpay VAP verifies only the email address, first name, last name, and
phone number.

If Worldpay VAP is your processor, you must contact Worldpay VAP to

register for EV.
Note

Card types:

 American Express

 Discover—only on TSYS Acquiring Solutions. Only the first name and last name are
checked.

EV confirms the customer’s billing information. When a customer provides incorrect

information, the transaction might be fraudulent.

Credit Card Services Using the Simple Order API | September 2019 94
 Chapter 3 Authorization Features

As part of EV for TSYS Acquiring Solutions and Worldpay VAP, you can
provide the IP address in the billTo_ipAddress field. When you provide the IP
Note address, American Express does not send a response for it. Instead, American
Express uses the IP address to run a check in their internal database to ensure
that the IP address does not match previously fraudulent transactions with the
same IP address and is not from countries that American Express has
determined to be a high risk for fraud. If, based on the IP address, American
Express determines that the transaction is fraudulent or is a high risk for fraud,
American Express declines the transaction.

Request Fields
To receive an EV response code for a particular value, you must include that value in your
authorization request. Table 27, "Request Fields for Electronic Verification," on page 95
lists the request fields for each value that EV can verify. In the table, the R/O column
indicates whether the field is required or optional for the authorization service.

Some merchants use placeholder data for some required fields, such as
addresses and phone numbers, because their customers do not provide them
Note with the required information. The benefit of using certain specific placeholder
values is that Decision Manager ignores the values instead of attempting to
process them. However, when you use placeholder data in any of the fields that
are used for EV, the corresponding EV results are invalid.

Table 27 Request Fields for Electronic Verification

Value That Is R/O for Request Field

Being Verified Authorizations
Email R billTo_email
2
First name R billTo_firstName
Last name2 R billTo_lastName
2
Phone number O billTo_phoneNumber
Postal code R/O1 billTo_postalCode
Street address R billTo_street1
1 Required when the billing country is the U.S. or Canada; otherwise, optional.
2 On American Express Direct, to receive EV response codes for the first name, last name, and phone
number, your account must be enabled for AAV+. See "Automated Address Verification Plus (AAV+),"
page 93.

Credit Card Services Using the Simple Order API | September 2019 95
 Chapter 3 Authorization Features

Reply Fields
For each verified value, EV returns a raw response code and a mapped response code:
 The raw response code is the value returned by the processor.
 The mapped response code is the pre-defined CyberSource value that corresponds to
the raw response code. Appendix M, "Electronic Verification Response Codes," on
page 486 describes the mapped response codes.

The following table lists the reply fields for each value that EV can verify.
Table 28 API Fields for Electronic Verification Responses

Value That Is API Field for Mapped API Field for Raw Response
Being Verified Response
Email ccAuthReply_evEmail ccAuthReply_evEmailRaw
First name and last ccAuthReply_evName ccAuthReply_evNameRaw
name
Phone number ccAuthReply_evPhoneNumber ccAuthReply_evPhoneNumberRaw
Postal code ccAuthReply_evPostalCode ccAuthReply_evPostalCodeRaw
Street address ccAuthReply_evStreet ccAuthReply_evStreetRaw

Credit Card Services Using the Simple Order API | September 2019 96
 Chapter 3 Authorization Features

Card Verification Numbers (CVNs)

Table 29 Processors That Support CVNs

Processors Payment Card Types

AIBMS Visa, Mastercard, Maestro (International),
Maestro (UK Domestic)
American Express Brighton American Express
American Express Direct American Express
Asia, Middle East, and Africa Visa, Mastercard, American Express, Diners Club
Gateway
Atos Visa, Mastercard, Cartes Bancaires
Barclays Visa, Mastercard, Maestro (UK Domestic)
Chase Paymentech Solutions Visa, Mastercard, American Express, Discover
Cielo Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Maestro (International), Elo, Aura
Comercio Latino Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Elo, Aura, Hipercard
CVN is required for all authorization requests except
recurring transactions. CyberSource returns a CVN
response value of 3 in the ccAuthReply_cvCode field in
the authorization reply, which indicates that the processor
did not send a CVN response. When you submit
authorizations without CVNs, Comercio Latino or your
acquirer declines them, unless you contact Comercio Latino
and your acquirer to configure your account to allow
transactions without CVNs. When a card fails the CVN
check, Comercio Latino declines the authorization.
Credit Mutuel-CIC Visa, Mastercard, Cartes Bancaires
CyberSource Latin American Visa, Mastercard, American Express, Elo
Processing
Note CyberSource Latin American Processing is the name
of a specific processing connection that CyberSource
supports. In the CyberSource API documentation,
CyberSource Latin American Processing does not refer to
the general topic of processing in Latin America.

CyberSource through VisaNet Visa, Mastercard, American Express, Diners Club, JCB,
Discover, mada as described in "mada Debit Cards,"
page 24

Credit Card Services Using the Simple Order API | September 2019 97
 Chapter 3 Authorization Features

Table 29 Processors That Support CVNs (Continued)

Processors Payment Card Types

Elavon Visa, Mastercard, Discover, Diners Club,
Maestro (UK Domestic), Maestro (International)
Note Elavon does not return a separate CVN response
field in the authorization reply. When the card fails the CVN
check, Elavon declines the authorization.
Elavon Americas Visa, Mastercard, American Express, JCB, Diners Club,
Discover, China UnionPay
FDC Compass Visa, Mastercard, American Express, Discover
FDC Germany Visa, Mastercard
FDC Nashville Global Visa, Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic)
Note For JCB cards, “US Domestic” means that the
currency is USD and your location is the U.S., Puerto Rico,
Guam, U.S. Virgin Islands, or Northern Mariana Islands.
FDI Australia Visa, Mastercard, American Express, Diners Club
FDMS Nashville Visa, Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic)
Note For JCB cards, “US Domestic” means that the
currency is USD and your location is the U.S., Puerto Rico,
Guam, U.S. Virgin Islands, or Northern Mariana Islands.
FDMS South Visa, Mastercard, American Express, Discover, Diners Club,
JCB (US Domestic)
Note For JCB cards, “US Domestic” means that the
currency is USD and your location is the U.S., Puerto Rico,
Guam, U.S. Virgin Islands, or Northern Mariana Islands.
GPN Visa, Mastercard, American Express, Discover, Diners Club
HBoS Visa, Mastercard
HSBC Visa, Mastercard, Maestro (International)
HSBC is the CyberSource name
for HSBC U.K.
Ingenico ePayments Visa, Mastercard
Ingenico ePayments was Note Do not include the CVN in a request for a recurring
previously called Global Collect. payment. See "Recurring Payments," page 207.
JCN Gateway Visa, Mastercard, American Express, Diners Club, JCB
Lloyds-Omnipay Visa, Mastercard
LloydsTSB Cardnet Visa, Mastercard
Lynk Visa, Mastercard, American Express, Discover, Diners Club
Moneris Visa, Mastercard, American Express

Credit Card Services Using the Simple Order API | September 2019 98
 Chapter 3 Authorization Features

Table 29 Processors That Support CVNs (Continued)

Processors Payment Card Types

OmniPay Direct Bank of America Merchant Services: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
Cardnet International: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
First Data Merchant Solutions (Europe): Visa, Mastercard,
Discover, Diners Club, Maestro (UK Domestic),
Maestro (International)
Global Payments International Acquiring: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
OmniPay-Ireland Visa, Mastercard
OmniPay-Ireland is the
CyberSource name for HSBC
International.
RBS WorldPay Atlanta Visa, Mastercard, American Express, Discover, Diners Club
RuPay RuPay
SIX Visa, Mastercard, Discover, Diners Club, JCB,
Maestro (International), Maestro (UK Domestic),
China UnionPay, Visa Electron
Streamline Visa, Mastercard, Maestro (UK Domestic), Cartes
Bancaires, Dankort
TSYS Acquiring Solutions Visa, Mastercard, American Express, Discover, Diners Club
Worldpay VAP Visa, Mastercard, American Express, Discover
Worldpay VAP was previously
called Litle.

Credit Card Services Using the Simple Order API | September 2019 99
 Chapter 3 Authorization Features

CVN Locations and Terminology

The CVN, which is printed or embossed on the back of the card, can be sent with the
request and verified to help reduce the risk of fraud.

Figure 3 Example of a Visa Card Verification Number

Each payment card company has its own name for this value:
 Visa calls it the Card Verification Value (CVV2).
 American Express and Discover call it the Card Identification Digits (CID).
 Mastercard calls it the Card Validation Code (CVC2).

To use the CVN, include the card_cvNumber field in the request. This number is never
transferred during card swipes and should be known only by the cardholder.

In Europe, Visa mandates that you must not include a CVN for mail-order
transactions and must not record a CVN on any physical format such as a mail-
Important order form.

CVN Codes
The reply message includes a raw response code and a mapped response code:

 The raw response code is the value returned by the processor. This value is returned
in the ccAuthReply_cvCodeRaw field. Use this value only for debugging purposes;
do not use it to determine the card verification response.

 The mapped response code is the pre-defined CyberSource value that corresponds to
the raw response code. This value is returned in the ccAuthReply_cvCode field.
Appendix J, "CVN Codes," on page 479 describes the mapped response codes.

Even when the CVN does not match the expected value, the issuing bank might still
authorize the transaction. You will receive a CVN decline from CyberSource, but you can
still capture the transaction because it has been authorized by the bank. However, you
must review the order to ensure that it is legitimate.

Credit Card Services Using the Simple Order API | September 2019 100
 Chapter 3 Authorization Features

Settling authorizations that fail the CVN check might have an impact on the fees charged
by your bank. Contact your bank for details about how card verification management
might affect your discount rate.

When a CVN decline is received for the authorization in a sale request, CyberSource does
not process the capture unless you set the businessRules_ignoreCVResult field to
true.

Table 30 CVN Results for Each Card Type

Card Type CVN Results

American Express A ccAuthReply_cvCode value of 1 indicates that your account is not configured for
CVN. Contact CyberSource Customer Support to have your account enabled for this
feature.
To use the CVN with American Express, see "Testing American Express Card
Verification," page 239.
Discover For FDC Nashville Global, FDMS Nashville, and FDMS South:
 CVN results can be returned for any of the card types on the Discover Network as
described in "Discover Acquisitions and Alliances," page 23.
 The CVN results are returned to you and it is your responsibility to decide whether or
not to accept the transaction.
For all other processors, when the CVN does not match:
 Discover refuses the card and the request is declined.
 The reply message does not include the ccAuthReply_cvCode field, which indicates
that the CVN failed.
Visa and Mastercard A CVN code of D or N causes CyberSource to decline the request with reason code 230.
You can still capture the transaction, but you must review the order to ensure that it is
legitimate.
Note CyberSource, not the issuing bank, assigns the CVN decline to the authorization.
You can capture any authorization that has a valid authorization code from the issuing
bank, even when the request receives a CVN decline.
When the issuing bank does not authorize the transaction and the CVN does not match,
the request is declined because the card is refused. You cannot capture the transaction.

Verbal Authorizations
CyberSource supports verbal authorizations for these processors:
 AIBMS
 American Express Brighton
 American Express Direct
 Asia, Middle East, and Africa Gateway
 Barclays

Credit Card Services Using the Simple Order API | September 2019 101
 Chapter 3 Authorization Features

 Chase Paymentech Solutions

 CyberSource through VisaNet
 Elavon
 Elavon Americas
 FDC Compass
 FDC Germany
 FDI Australia
 FDC Nashville Global
 FDMS Nashville
 FDMS South
 GPN
 HBoS
 HSBC: HSBC is the CyberSource name for HSBC U.K.
 JCN Gateway
 Lloyds-OmniPay
 LloydsTSB Cardnet
 Lynk
 Moneris
 OmniPay Direct. The supported acquirers are:
 Bank of America Merchant Services
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 OmniPay-Ireland: OmniPay-Ireland is the CyberSource name for HSBC International.

 RBS WorldPay Atlanta
 TSYS Acquiring Solutions
 UATP
 Worldpay VAP—Worldpay VAP was previously called Litle.

Verbal authorizations are not supported for Comercio Latino or CyberSource

Latin American Processing.
Note CyberSource Latin American Processing is the name of a specific processing
connection that CyberSource supports. In the CyberSource API
documentation, CyberSource Latin American Processing does not refer to
the general topic of processing in Latin America. The information in this note
is for the specific processing connections called Comercio Latino and
CyberSource Latin American Processing. It is not for any other Latin
American processors that CyberSource supports.

Credit Card Services Using the Simple Order API | September 2019 102
 Chapter 3 Authorization Features

Do not use Dynamic Currency Conversion with a verbal authorization.

Important

When you request an authorization through CyberSource, the issuing bank might ask you
to call the payment processor to answer questions about the transaction. When this
happens, the processor gives you a verbal authorization code for the transaction. To
capture a verbally authorized transaction, send the verbal authorization code in the
capture request. Make sure your customer service and point-of-sale staff can enter verbal
authorization codes into your system.

You can use a verbal authorization to capture an authorization that was declined for any of
these reasons:
 Verbal authorization required
 Card expired
 Card refused
 Invalid card

Do not confuse verbal authorizations with forced captures:

 With a verbal authorization, you obtain the authorization code directly
Important from the processor or issuing bank after requesting an authorization
through CyberSource and receiving a CyberSource decline.
 With a forced capture, you get the authorization code by authorizing a
payment outside of CyberSource. See "Forced Captures," page 142.
In both cases, you must follow up with a capture that uses the CyberSource
system.

A verbal authorization works as follows:

1 The authorization reply includes reason code 201, which indicates that the issuing bank is
requiring a verbal authorization.
For the American Express card type on FDMS Nashville, the authorization reply also
includes a referral response number in ccAuthReply_referralResponseNumber. You
will be asked for this number, which identifies the failed transaction, when you call
American Express for the verbal authorization.

2 You call the processor to answer questions about the transaction.

3 When the processor verbally authorizes the transaction, the processor gives you a verbal
authorization code.

Credit Card Services Using the Simple Order API | September 2019 103
 Chapter 3 Authorization Features

4 You include the verbal authorization code in your capture request:

 Send the verbal authorization code in the ccCaptureService_verbalAuthCode field.

 Send the word verbal in the ccCaptureService_authType field.

When you do not set ccCaptureService_authType to verbal, CyberSource ignores
the ccCaptureService_verbalAuthCode field.

 For the American Express card type on American Express Direct or FDMS South, the
ccCaptureService_posData and ccCaptureService_transactionID fields are
required to comply with the CAPN requirements.

American Express has indicated that capture requests submitted without a

valid transaction ID, including transactions that originated as verbal
Note authorizations, might incur additional transaction charges. Contact your
American Express account representative to learn whether your processing is
affected by these additional transaction charges.

Credit Card Services Using the Simple Order API | September 2019 104
 CHAPTER
Features for Debit Cards
and Prepaid Cards
4

Debit cards and prepaid cards are processed using the credit card services described in
this document. This chapter describes the special features that are available for debit
cards and prepaid cards: partial authorizations and balance responses.

To process domestic debit transactions on CyberSource through VisaNet with

Mastercard in Canada, you must contact CyberSource Customer Support to
Note have your account configured for this feature.

When you use the Simple Order API in XML format, you must use version 1.52
or later of the XML schema to implement partial authorizations or balance
Note responses.

Partial Authorizations

The partial authorization functionality does not apply to credit cards.

Note

For debit cards and prepaid cards, the issuing bank can approve a partial amount if the
balance on the card is less than the requested authorization amount.

Credit Card Services Using the Simple Order API | September 2019 105
 Chapter 4 Features for Debit Cards and Prepaid Cards

Supported Processors and Card Types

The following table lists the processors and card types for which CyberSource supports
partial authorizations. If your processor and card type are not listed in the table, see
"Unsupported Processors and Card Types," page 115.

Table 31 Processors Supported for Partial Authorizations

Processor Card Types for Debit Cards and Prepaid Cards

American Express Direct American Express
Chase Paymentech Solutions Visa, Mastercard, American Express, Discover, Diners Club
CyberSource through Visa, Mastercard, American Express, Diners Club, JCB,
VisaNet Discover, mada as described in "mada Debit Cards," page 24
Important Partial authorizations are not available for
Mastercard transactions in the IDR currency on CyberSource
through VisaNet.
Elavon Americas Visa, Mastercard, American Express, JCB, Diners Club,
Discover, China UnionPay
FDC Compass1 Visa, Mastercard, American Express, Discover
FDC Nashville Global Visa, Mastercard, American Express, Discover2, Diners Club2,
China UnionPay, JCB (US Domestic)2,3
FDMS Nashville Visa, Mastercard, American Express, Discover2, Diners Club2,
JCB (US Domestic)2,3
FDMS South4 Visa, Mastercard, American Express, Discover2,
JCB (US Domestic)2,3
GPN Visa, Mastercard, American Express, Discover, Diners Club,
JCB
TSYS Acquiring Solutions Visa, Mastercard, American Express, Discover, Diners Club,
JCB
Worldpay VAP Visa, Mastercard, American Express, Discover, Diners Club,
JCB
Worldpay VAP was
previously called Litle.
1 FDC Compass might support partial authorizations for additional card types in the future so be prepared
to handle partial authorizations for all card types if your account is enabled for partial authorizations.
2 For this card type on the specified processor, partial authorizations are supported for credit cards in
addition to debit cards and prepaid cards.
3 For JCB cards, “US Domestic” means that the currency is USD and your location is the U.S., Puerto Rico,
Guam, U.S. Virgin Islands, or Northern Mariana Islands.
4 FDMS South might support partial authorizations for additional card types in the future so be prepared to
handle partial authorizations for all card types if your account is enabled for partial authorizations.

Credit Card Services Using the Simple Order API | September 2019 106
 Chapter 4 Features for Debit Cards and Prepaid Cards

Opting In
If you accept American Express cards and Chase Paymentech Solutions is
your processor, see "Special Processing for American Express Cards on
Note Chase Paymentech Solutions," page 109.

You must opt in to be able to receive and capture partial authorizations. There are two
ways to opt in:

 You can call CyberSource Customer Support to have your account enabled for partial
authorizations. When you do this, all your authorization requests are enabled for
partial authorizations.
or
 You can set ccAuthService_partialAuthIndicator to true in your authorization or
sale request. When you do this, only that specific transaction is enabled for partial
authorization.

Opting Out
When your account is enabled for partial authorizations, you can disable partial
authorization for a specific transaction by setting ccAuthService_partialAuthIndicator to
false in your authorization or sale request.

How a Partial Authorization Works

Support for your processor and card type does not guarantee a partial
authorization. The issuing bank decides whether or not to approve a partial
Note amount.

When the balance on a debit card or prepaid card is less than the requested authorization
amount, the issuing bank can approve a partial amount. When this happens, you can
accept multiple forms of payment for the order starting with some or all of the approved
amount followed by one or more different payment methods:

1 If your account is not configured for partial authorizations, you must enable partial
authorizations for the transaction by setting ccAuthService_partialAuthIndicator to
true in your request.

If you accept American Express cards and Chase Paymentech Solutions is

your processor, see "Special Processing for American Express Cards on
Note Chase Paymentech Solutions," page 109.

Credit Card Services Using the Simple Order API | September 2019 107
 Chapter 4 Features for Debit Cards and Prepaid Cards

If you accept IDR or CLP currencies on FDMS South, see "Special Processing
for IDR and CLP on FDMS South," page 109.
Note

2 You submit an authorization request or a sale request for a debit card or prepaid card.

3 The authorization reply message from CyberSource includes:

 ccAuthReply_requestAmount: amount you requested
 ccAuthReply_requestCurrency: currency for the amount you requested
 ccAuthReply_amount: amount that was authorized
 purchaseTotals_currency: currency for the amount that was authorized
 requestID: value you can use to link this authorization request to subsequent
transactions

If you requested a sale, the authorization was not captured.

Note

4 You submit a capture request for the partial authorization.

When you capture only part of the approved amount, CyberSource or your processor
might be able to perform an automatic partial authorization reversal for you. See
"Automatic Partial Authorization Reversals," page 69.

If you do not capture the partial authorization, you must request a full
authorization reversal if this service is supported for your processor and card
Note type. See "Reversing an Authorization," page 52.

5 You use one or more different payment methods for the rest of the order amount.

When you process these payment methods through CyberSource, you can use the
linkToRequest field to link the payment requests to the original authorization request. Set
linkToRequest to the requestID value that was returned in the reply message for the
original authorization request.

Credit Card Services Using the Simple Order API | September 2019 108
 Chapter 4 Features for Debit Cards and Prepaid Cards

Special Processing for American Express Cards on

Chase Paymentech Solutions
If you accept American Express cards and Chase Paymentech Solutions is your
processor, perform the following procedure to opt in to partial authorizations.

To opt in to partial authorizations for American Express cards on

Chase Paymentech Solutions:

Step 1 Contact Chase Paymentech Solutions to have your account enabled for partial
authorizations for the American Express card type. The transaction division for partial
authorizations for American Express should be set to 3.

This step is only for the American Express card type on Chase Paymentech
Solutions. For all other card types on Chase Paymentech Solutions, the
Important transaction division for partial authorizations should be set to the default value
of 0 (zero).

Step 2 Contact CyberSource Customer Support to have your account enabled for partial
authorizations.
After your accounts have been enabled for partial authorizations at Chase Paymentech
Solutions and at CyberSource, you can disable partial authorizations for a specific
transaction by setting ccAuthService_partialAuthIndicator to false in your
authorization or sale request.

Special Processing for IDR and CLP on FDMS South

For the Indonesian rupiah (IDR) and Chilean peso (CLP) currencies only:

 Rounding occurs, which can cause a minor discrepancy of up to one currency unit
between the amount you requested and the amount that is authorized.

 When a transaction is enabled for partial authorization, you must ensure that the
requested amount does not include any digits to the right of the decimal separator.

Credit Card Services Using the Simple Order API | September 2019 109
 Chapter 4 Features for Debit Cards and Prepaid Cards

Real-Time Reversals
There are two kinds of real-time reversals:

 A full authorization reversal is a service that you can request.

If you do not capture a partial authorization and if full authorization reversals are
supported for your processor and card type, you must request a full authorization
reversal to release the hold that the authorization placed on the customer’s funds. The
amount of the reversal must be the amount that was authorized, not the amount that
was requested. For details about this service and to see the processors and card
types for which this service is supported, see "Reversing an Authorization," page 52.

 An automatic partial authorization reversal is performed automatically by CyberSource

or your processor under certain conditions.
When you capture a partial authorization for an amount that is less than the approved
amount, CyberSource automatically performs a partial authorization reversal if it is
supported for your processor and card type. CyberSource performs the automatic
partial authorization reversal before sending the capture request to the processor.

Some processors perform an automatic partial authorization reversal when

there is an interchange benefit. These processors do not allow
Note CyberSource to perform this functionality.

For details about automatic partial authorization reversals and for a list of the
processors and card types for which it is supported, see "Automatic Partial
Authorization Reversals," page 69.

Credit Card Services Using the Simple Order API | September 2019 110
 Chapter 4 Features for Debit Cards and Prepaid Cards

Balance Responses

Balance inquiries and balance responses are two different features:

 Balance responses are supported for prepaid cards and are a partial
Note authorization feature.
 Balance inquiries are not associated with partial authorizations. See
"Balance Inquiries," page 128.

Normally, balance responses are not returned for debit cards.

Note

To receive balance responses from Worldpay VAP, your Worldpay VAP

account must be enabled for this feature.
Note

When there is a balance remaining on a prepaid card after an authorization, the

authorization reply can include the balance amount. Depending on what data your
processor sends to CyberSource, the following fields might be included in the reply:

 ccAuthReply_accountBalance: balance amount remaining on the prepaid card after

the authorization

For Discover, some processors return the balance in the ccAuthReply_

authorizationCode field.
Note

 ccAuthReply_accountBalanceCurrency: currency of the balance amount

 ccAuthReply_accountBalanceSign: sign for the balance amount

For descriptions of these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 111
 Chapter 4 Features for Debit Cards and Prepaid Cards

The following table lists the processors and card types for which balance responses are
supported. Depending on what data your processor sends to CyberSource, the following
fields might be included in the reply.
Table 32 Processors Supported for Balance Responses

Processor Card Type Balance Currency Sign

Field 1 Field Field
American Express Direct American Express Yes Yes No
Chase Paymentech Visa Yes Yes No
Solutions
Mastercard Yes Yes No
American Express Yes Yes No
Discover Yes Yes No
Diners Club Yes Yes No
Maestro (International) Yes Yes No
CyberSource through Visa Yes Yes Yes
VisaNet
Mastercard Yes Yes Yes
American Express Yes Yes Yes
Discover Yes Yes Yes
Diners Club Yes Yes Yes
JCB Yes Yes Yes
2
mada Yes Yes Yes
Elavon Americas Visa Yes No No
Mastercard Yes No No
American Express Yes No No
Discover Yes No No
Diners Club Yes No No
China UnionPay Yes No No
JCB Yes No No
FDC Compass Visa Yes Yes No
Mastercard Yes Yes No
American Express Yes Yes No
Discover Yes Yes No
1 For Discover, some processors return the balance in the ccAuthReply_authorizationCode field.
2 See "mada Debit Cards," page 24.

Credit Card Services Using the Simple Order API | September 2019 112
 Chapter 4 Features for Debit Cards and Prepaid Cards

Table 32 Processors Supported for Balance Responses (Continued)

Processor Card Type Balance Currency Sign

Field 1 Field Field
FDC Nashville Global Visa Yes Yes Yes
Mastercard Yes Yes Yes
American Express Yes Yes Yes
Discover Yes Yes Yes
Diners Club Yes Yes Yes
China UnionPay Yes Yes Yes
JCB Yes Yes Yes
FDMS Nashville Visa Yes Yes Yes
Mastercard No No No
American Express Yes Yes Yes
Discover No No No
Diners Club No No No
JCB No No No
FDMS South Visa Yes Yes Yes
Mastercard No No No
American Express Yes Yes Yes
Discover No No No
Diners Club No No No
JCB No No No
GPN Visa Yes Yes Yes
Mastercard Yes Yes Yes
American Express Yes Yes Yes
Discover Yes Yes Yes
Diners Club Yes Yes Yes
JCB Yes Yes Yes
TSYS Acquiring Visa Yes Yes Yes
Solutions
Mastercard Yes Yes Yes
American Express Yes Yes Yes
Discover Yes Yes Yes
Diners Club Yes Yes Yes
JCB Yes Yes Yes
1 For Discover, some processors return the balance in the ccAuthReply_authorizationCode field.
2 See "mada Debit Cards," page 24.

Credit Card Services Using the Simple Order API | September 2019 113
 Chapter 4 Features for Debit Cards and Prepaid Cards

Table 32 Processors Supported for Balance Responses (Continued)

Processor Card Type Balance Currency Sign

Field 1 Field Field
Worldpay VAP Visa Yes Yes No
Worldpay VAP was Mastercard Yes Yes No
previously called Litle.
American Express Yes Yes No
Discover Yes Yes No
Diners Club Yes Yes No
JCB Yes Yes No
1 For Discover, some processors return the balance in the ccAuthReply_authorizationCode field.
2 See "mada Debit Cards," page 24.

Credit Card Services Using the Simple Order API | September 2019 114
 Chapter 4 Features for Debit Cards and Prepaid Cards

Features for Maestro (UK Domestic) Cards

To see which processors support Maestro (UK Domestic) cards, see "Payment
Processors," page 32.

This section previously covered Solo cards, but Solo cards are being phased
out.
Note

Maestro (UK Domestic) cards were previously called Switch cards.

Note

Maestro (UK Domestic) cards are debit cards that originate in the United Kingdom. These
cards can have the following features:

 Issue number: A Maestro (UK Domestic) card might have an issue number embossed
on it. The issue number can consist of one or two digits; the first digit can be a zero.
An issue number of 2 is different from 02.

Effective May 2011, the issue number is no longer required for

Maestro (UK Domestic) transactions.
Note

 Start date: A Maestro (UK Domestic) card might have a start date embossed on it. The
start date consists of a month and year.

Effective May 2011, the start date is no longer required for

Maestro (UK Domestic) transactions.
Note

Unsupported Processors and Card Types

Prepaid cards and debit cards that do not appear in Table 31, "Processors Supported for
Partial Authorizations," on page 106 are processed as follows:

 When the card balance is sufficient for the requested transaction, the transaction is
successful.

 When the card balance is not sufficient for the requested transaction, the request is
declined.

Credit Card Services Using the Simple Order API | September 2019 115
 CHAPTER
Optional Features
5

0 Authorizations
See "Zero Amount Authorizations," page 231.

Additional Amounts
Services:
 Capture
 Credit

Processor:
 American Express Direct

This feature enables you to provide detailed information about specific amounts included
in a transaction. For example, if a transaction amount includes a gratuity of 5.00, you can
include these fields in the capture or credit request:
purchaseTotals_additionalAmount0=5.0
purchaseTotals_additionalAmountType0=058

You can include a maximum of five additional amounts in a transaction. For each amount,
you must include an amount field and an amount type field:
 purchaseTotals_additionalAmount0 through purchaseTotals_additionalAmount4
 purchaseTotals_additionalAmountType0 through purchaseTotals_
additionalAmountType4

The additional amount type values are listed in Appendix C, "Additional Amount Types,"
on page 462.

Credit Card Services Using the Simple Order API | September 2019 116
 Chapter 5 Optional Features

Shipping and Handling Fees

Additional amount fields for shipping and handling fees take precedence over item-level
fields. See the following example.

Example 1 Shipping and Handling Fees

1 You include the following lines in your request:

purchaseTotals_additionalAmount0=9.95
purchaseTotals_additionalAmountType0=055
item_0_productCode=shipping_and_handling
item_0_unitPrice=12.95

2 CyberSource processes the additional amount fields for the shipping and handling
amount of 9.95. The item-level fields for the shipping and handling amount are
ignored.

Taxes
Additional amount fields for taxes take precedence over item-level fields. See the following
example.

Example 2 Taxes

1 You include the following lines in your request:

purchaseTotals_additionalAmount0=7.95
purchaseTotals_additionalAmountType0=046
item_0_taxAmount=5.95

2 CyberSource processes the additional amount fields for the tax amount of 7.95. The
item-level field for the tax amount is ignored.

Aggregator Support
This feature enables a third-party agent to act as a payment aggregator and process
payment card transactions for sub-merchants. Independent sales organizations (ISOs)
and member service providers (MSPs) are agents that can also leverage these aggregator
features.

Contact CyberSource Customer Support to have your account configured for this feature.

Credit Card Services Using the Simple Order API | September 2019 117
 Chapter 5 Optional Features

Terminology
Table 33 Aggregator Terminology

Term Definition
aggregator Also known as payment aggregator. Organization that aggregates sub-
merchants under a single account and settles funds directly to the sub-
merchants. An aggregator is usually an ISO or MSP.
independent sales Organization that does one or more of the following:
organization (ISO)
 Works with acquirers to sponsor merchant accounts and usually
assumes the risks associated with the merchants’ processing.
 Procures new merchant relationships based on contracts with
acquirers.
 Connects with a gateway to process online payment card
transactions for small businesses, usually in exchange for a fee or
percentage of sales.
member service Same as an ISO although an MSP has no financial responsibility to the
provider (MSP) merchant.
payment facilitator Payment aggregator.
service provider Third-party or outsource provider of payment processing services. A
service provider typically provides a single service with no role in settling
funds to a merchant.
sub-merchant Merchant whose transactions are submitted to CyberSource by a
payment aggregator.
third-party agent Umbrella term for independent sales organizations, member service
providers, payment aggregators, and payment facilitators.

American Express Direct Aggregators

Services:
 Authorization
 Capture
 Credit

Card type:
 American Express

The following fields are required for aggregator transactions when requesting an
authorization, capture, or credit:
 ccAuthService_aggregatorID—required only for the authorization service
 ccAuthService_aggregatorName—required only for the authorization service
 ccCaptureService_aggregatorID—required only for the capture service
 ccCaptureService_aggregatorName—required only for the capture service

Credit Card Services Using the Simple Order API | September 2019 118
 Chapter 5 Optional Features

 ccCreditService_aggregatorID—required only for the credit service

 ccCreditService_aggregatorName—required only for the credit service
 invoiceHeader_submerchantCity
 invoiceHeader_submerchantCountry
 invoiceHeader_submerchantEmail
 invoiceHeader_submerchantID
 invoiceHeader_submerchantName
 invoiceHeader_submerchantPostalCode
 invoiceHeader_submerchantState
 invoiceHeader_submerchantStreet
 invoiceHeader_submerchantTelephoneNumber
 merchantCategoryCode

The following fields are optional for aggregator transactions:

 invoiceHeader_merchantDescriptor
 invoiceHeader_merchantDescriptorCity
 invoiceHeader_merchantDescriptorContact
 invoiceHeader_merchantDescriptorCountry
 invoiceHeader_merchantDescriptorPostalCode
 invoiceHeader_merchantDescriptorState
 invoiceHeader_merchantDescriptorStreet

All fields except the merchant descriptor fields are described in Appendix A, "API Fields,"
on page 240. For information about the merchant descriptor fields, see Merchant
Descriptors Using the Simple Order API.

Typically, the merchant descriptor field is used to display your business name on the
customer's statement. However, when you are a payment aggregator, you can use other
values to provide the sub-merchant’s business name for capture and credit requests. The
following table describes these values. The order of the values in the table is the order that
CyberSource uses to determine which values to use.

Credit Card Services Using the Simple Order API | September 2019 119
 Chapter 5 Optional Features

Table 34 Values for Providing a Sub-Merchant’s Business Name on American Express Direct

Option Values Description

1 Aggregator Name + Aggregator Name
Sub-merchant The aggregator name is an API field you can include in your request. The API
Name fields are ccAuthService_aggregatorName, ccCaptureService_
aggregatorName, and ccCreditService_aggregatorName.
Sub-merchant Name
The sub-merchant name is the value from the invoiceHeader_
suberchantName field.
Aggregator Name + Sub-merchant Name
When you include the aggregator name field in your request and when your
CyberSource account information includes a sub-merchant name,
CyberSource combines these two values to provide the business name
information for the customer’s statement. This approach is advantageous
because it allows the business name information to be longer than the size of
the merchant descriptor field, which has a length of 27 characters.
The total length of the value that CyberSource sends to the processor is 36
characters. It is formatted with an asterisk (*) between the aggregator name
and the sub-merchant name:
aggregator name*sub-merchant name
Because the asterisk uses one character, 35 characters remain for the
combined length of the aggregator name and sub-merchant name.
Important If the combined length of the aggregator name and sub-merchant
name exceeds 36 characters, CyberSource declines the transaction.
2 Merchant Descriptor When you do not provide the values for the preceding option, you can provide
the business name in the merchant descriptor field invoiceHeader_
merchantDescriptor. This field is described in Merchant Descriptors Using the
Simple Order API.
3 Merchant Name When you do not provide the values for the preceding two options,
CyberSource uses the merchant name in your CyberSource account. To add
this value to your CyberSource account, contact CyberSource Customer
Support.

Credit Card Services Using the Simple Order API | September 2019 120
 Chapter 5 Optional Features

CyberSource through VisaNet Aggregators

Services:
 Authorization
 Capture
 Credit

Card types:
 American Express
 Diners Club
 Discover
 JCB
 Mastercard
 Visa

Aggregator Transactions with American Express

Authorizations
When requesting an authorization, you must include the following fields:
 ccAuthService_aggregatorID
 ccAuthService_aggregatorName
 invoiceHeader_submerchantCity
 invoiceHeader_submerchantName
 invoiceHeader_submerchantStreet

These fields are optional:

 invoiceHeader_submerchantCountry
 invoiceHeader_submerchantEmail
 invoiceHeader_submerchantID
 invoiceHeader_submerchantPostalCode
 invoiceHeader_submerchantState
 invoiceHeader_submerchantTelephoneNumber

The preceding fields are described in Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 121
 Chapter 5 Optional Features

Captures and Credits

When requesting a capture or credit, these fields are optional:
 invoiceHeader_merchantDescriptor
 invoiceHeader_merchantDescriptorCity
 invoiceHeader_merchantDescriptorContact
 invoiceHeader_merchantDescriptorCountry
 invoiceHeader_merchantDescriptorPostalCode
 invoiceHeader_merchantDescriptorState
 invoiceHeader_merchantDescriptorStreet
 invoiceHeader_submerchantEmail
 invoiceHeader_submerchantID
 invoiceHeader_submerchantTelephoneNumber
 merchantCategoryCode

All fields except the merchant descriptor fields are described in Appendix A, "API Fields,"
on page 240. The merchant descriptor fields are described in Merchant Descriptors Using
the Simple Order API.

Typically, the merchant descriptor field is used to display your business name on the
customer's statement. However, when you are a payment aggregator, you can use other
values to provide the sub-merchant’s business name for capture and credit requests.
When you do not provide a value in the merchant descriptor fields, CyberSource uses the
values in your CyberSource account. To add or update the values in your CyberSource
account, contact CyberSource Customer Support.

Aggregator Transactions with Mastercard

When requesting an authorization, you must include the following fields:
 ccAuthService_aggregatorID
 invoiceHeader_salesOrganizationID
 invoiceHeader_submerchantID

When requesting an authorization, capture, or credit, these fields are optional:

 invoiceHeader_merchantDescriptor
 invoiceHeader_merchantDescriptorCity
 invoiceHeader_merchantDescriptorContact
 invoiceHeader_merchantDescriptorCountry
 invoiceHeader_merchantDescriptorPostalCode
 invoiceHeader_merchantDescriptorState
 invoiceHeader_merchantDescriptorStreet
 merchantCategoryCode

Credit Card Services Using the Simple Order API | September 2019 122
 Chapter 5 Optional Features

All fields except the merchant descriptor fields are described in Appendix A, "API Fields,"
on page 240. The merchant descriptor fields are described in Merchant Descriptors Using
the Simple Order API.

Typically, the merchant descriptor field is used to display your business name on the
customer's statement. However, when you are a payment aggregator, you can use other
values to provide the sub-merchant’s business name for capture and credit requests.
When you do not provide a value in the merchant descriptor fields, CyberSource uses the
values in your CyberSource account. To add or update the values in your CyberSource
account, contact CyberSource Customer Support.

Aggregator Transactions with Any Other Card Type

When requesting an authorization, capture, or credit, these fields are optional:
 invoiceHeader_merchantDescriptor
 invoiceHeader_merchantDescriptorCity
 invoiceHeader_merchantDescriptorContact
 invoiceHeader_merchantDescriptorCountry
 invoiceHeader_merchantDescriptorPostalCode
 invoiceHeader_merchantDescriptorState
 invoiceHeader_merchantDescriptorStreet
 merchantCategoryCode

All fields except the merchant descriptor fields are described in Appendix A, "API Fields,"
on page 240. The merchant descriptor fields are described in Merchant Descriptors Using
the Simple Order API.

Typically, the merchant descriptor field is used to display your business name on the
customer's statement. However, when you are a payment aggregator, you can use other
values to provide the sub-merchant’s business name for capture and credit requests.
When you do not provide a value in the merchant descriptor fields, CyberSource uses the
values in your CyberSource account. To add or update the values in your CyberSource
account, contact CyberSource Customer Support.

Credit Card Services Using the Simple Order API | September 2019 123
 Chapter 5 Optional Features

FDC Compass Aggregators

Services:
 Authorization
 Capture
 Credit

Card types:
 American Express
 Mastercard

The following fields are required for aggregator transactions with American Express or
Mastercard when requesting an authorization, capture, or credit:
 ccAuthService_aggregatorID—required only for the authorization service
 ccAuthService_aggregatorName—required only for the authorization service with
Mastercard
 ccCaptureService_aggregatorID—required only for the capture service
 ccCaptureService_aggregatorName—required only for the capture service with
Mastercard
 ccCreditService_aggregatorID—required only for the credit service
 ccCreditService_aggregatorName—required only for the credit service with
Mastercard
 invoiceHeader_submerchantCity
 invoiceHeader_submerchantID
 invoiceHeader_submerchantName
 invoiceHeader_submerchantTelephoneNumber

The following fields are optional for aggregator transactions:

 invoiceHeader_submerchantCountry
 invoiceHeader_submerchantEmail
 invoiceHeader_submerchantPostalCode
 invoiceHeader_submerchantState
 invoiceHeader_submerchantStreet
 merchantCategoryCode—supported only for the authorization service

All fields are described in Appendix A, "API Fields," on page 240.

For Mastercard aggregator captures and credits, CyberSource combines the following two
values to provide the business name information for the customer’s statement:
 Aggregator name in the ccCaptureService_aggregatorName or ccCreditService_
aggregatorName field.
 Sub-merchant name in the invoiceHeader_suberchantName field.

Credit Card Services Using the Simple Order API | September 2019 124
 Chapter 5 Optional Features

The total length of the value that CyberSource sends to the processor is 36 characters. It
is formatted with an asterisk (*) between the aggregator name and the sub-merchant
name:
aggregator name*sub-merchant name

Because the asterisk uses one character, 37 characters remain for the combined length of
the aggregator name and sub-merchant name.

If the combined length of the aggregator name and sub-merchant name

exceeds 37 characters, CyberSource declines the transaction.
Important

FDC Nashville Global Aggregators

Services:
 Authorization
 Capture
 Credit

Card types:
 American Express
 Mastercard

The following fields are required for aggregator transactions with American Express or
Mastercard when requesting an authorization, capture, or credit:
 ccAuthService_aggregatorID—required only for the authorization service
 ccAuthService_aggregatorName—required only for the authorization service
 ccCaptureService_aggregatorID—required only for the capture service
 ccCaptureService_aggregatorName—required only for the capture service
 ccCreditService_aggregatorID—required only for the credit service
 ccCreditService_aggregatorName—required only for the credit service
 invoiceHeader_submerchantCity
 invoiceHeader_submerchantCountry
 invoiceHeader_submerchantEmail
 invoiceHeader_submerchantID
 invoiceHeader_submerchantName
 invoiceHeader_submerchantPostalCode
 invoiceHeader_submerchantState
 invoiceHeader_submerchantStreet
 invoiceHeader_submerchantTelephoneNumber
 merchantCategoryCode

Credit Card Services Using the Simple Order API | September 2019 125
 Chapter 5 Optional Features

The following fields are optional for aggregator transactions:

 invoiceHeader_submerchantMerchantID—supported only for American Express
 invoiceHeader_submerchantRegion

All fields are described in Appendix A, "API Fields," on page 240.

Airline Data
See Airline Processing Using the Simple Order API.

American Express SafeKey

See "Payer Authentication," page 186.

Android Pay
The name of Android Pay changed to Google Pay. See Google Pay Using the Simple
Order API.

Apple Pay
See Apple Pay Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 126
 Chapter 5 Optional Features

Authorization Only
Service:
 Authorization

Processors:
 American Express Direct
 Elavon Americas

In the authorization reply message, CyberSource provides you with point-of-sale (POS)
and transaction ID (TID) values. When you perform authorizations through CyberSource
and perform captures and credits through other financial institutions, you can include
these values in your capture requests and follow-on credit requests:
 POS data: Get this value from ccAuthReply_posData.
 TID: Get this value from ccAuthReply_transactionID.

Including these values in your capture requests and follow-on credit requests enables you
to comply with the CAPN requirements, thus avoiding noncompliance fees.

When you use the Simple Order API in XML format, you must use version 1.63
or later of the XML schema to implement the authorization only feature.
Note

AVS Only
See "Zero Amount Authorizations," page 231.

Credit Card Services Using the Simple Order API | September 2019 127
 Chapter 5 Optional Features

Balance Inquiries
Service:
 Authorization

Processors:
 CyberSource through VisaNet
 Elavon Americas

Balance inquiries and balance responses are two different features:

 Balance responses are supported for prepaid cards and are a partial
Note authorization feature. See "Balance Responses," page 111.

 Balance inquiries are not associated with partial authorizations.

This feature enables you to request balance information for an account.

To use this feature, include the balanceInquiry field in an authorization request. The
amount in the request must be zero.

CyberSource returns the following fields:

 ccAuthReply_accountBalance
 ccAuthReply_accountBalanceCurrency
 ccAuthReply_accountBalanceSign
 ccAuthReply_accountType
 ccAuthReply_amountType

These fields are described in "API Fields," page 240.

Bill Payments with Mastercard

See "Mastercard Bill Payments," page 167.

Bill Payments with Visa

See "Visa Bill Payments," page 229.

Credit Card Services Using the Simple Order API | September 2019 128
 Chapter 5 Optional Features

BNDES
Services:
 Authorization
 Credit

Card types:
 Mastercard
 Visa

Processor:
 CyberSource through VisaNet

BNDES is card product the same way Visa Platinum, Visa Corporate, and Mastercard
Corporate are products. BNDES is also a bank named Brazilian Development Bank. The
BNDES bank issues the BNDES card products.

To indicate that a transaction on CyberSource through VisaNet is a

BNDES Mastercard transaction:

Step 1 You must include the following fields in your authorization or credit request:
 billTo_companyTaxID
 billTo_merchantTaxID
 card_productName

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on CyberSource through VisaNet is a

BNDES Visa transaction:

Step 1 You must include the following fields in your authorization or credit request:
 billTo_personalID or billTo_companyTaxID
 card_productName
 loan_assetType
 loan_type

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 129
 Chapter 5 Optional Features

Card-on-File Transactions
See "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF) Transactions,"
page 173.

Card-Present Data
See Card-Present Processing Using the Simple Order API.

Card Type Indicators (CTIs)

Service:
 Authorization

Processors:
 Chase Paymentech Solutions
 Worldpay VAP—Worldpay VAP was previously called Litle.

Contact your processor to have your account configured for this feature.
Contact CyberSource Customer Support to have your account configured for
Note this feature.

This feature enables you to receive CTI information in your authorization reply messages.
The processor can provide CTI information for approved or declined transactions, not for
rejected transactions.

The CTI information is returned in the following fields:

 ccAuthReply_affluenceIndicator
 ccAuthReply_cardCommercial
 ccAuthReply_cardHealthcare
 ccAuthReply_cardIssuerCountry
 ccAuthReply_cardLevel3Eligible
 ccAuthReply_cardPayroll
 ccAuthReply_cardPINlessDebit
 ccAuthReply_cardPrepaid
 ccAuthReply_cardRegulated
 ccAuthReply_cardSignatureDebit

Credit Card Services Using the Simple Order API | September 2019 130
 Chapter 5 Optional Features

For Worldpay VAP, CTI information is also returned in the following fields:
 card_prepaidReloadable
 card_prepaidType
 card_virtual

The CTI fields are described in Appendix A, "API Fields," on page 240.

To receive CTI information on Chase Paymentech Solutions:

Your authorization request message must comply with the CTI acceptance criteria as
described in the following table.

Table 35 CTI Acceptance Criteria

Card Type Acceptance Criteria

American Express CTI is not supported.
Carte Blanche CTI is not supported.
Diners Club Currency is USD or CAD.
Discover Currency is USD or CAD.
JCB Currency is USD.
Mastercard Any currency.
Visa Amount is not 0 (zero). Any currency.

To receive CTI information on Worldpay VAP:

CyberSource returns CTI information in the authorization reply message.

Credit Card Services Using the Simple Order API | September 2019 131
 Chapter 5 Optional Features

Cash Advances
Services:
 Authorization
 Capture

Processors:
 Barclays
 LloydsTSB Cardnet

A cash advance enables a customer to use a payment card to purchase foreign currency
or travelers checks. The currency the customer uses to fund the transactions must be
British pounds.

Before processing cash advances, you must:

 Contact the processor to obtain an agreement to process cash advance transactions.
 Contact CyberSource Customer Support to have your account configured for this
feature. You must have a separate CyberSource merchant ID that you use only for
cash advance transactions.

Process a cash advance transaction the same way you process a regular credit card
transaction: with an authorization and a capture.

You cannot process a cash advance and airline data in the same transaction.

Important

Chase Pay
See Chase Pay Using the Simple Order API.

Credentials-on-File Transactions
See "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF) Transactions,"
page 173.

Customer Profiles
See "Payment Tokenization," page 204.

Credit Card Services Using the Simple Order API | September 2019 132
 Chapter 5 Optional Features

Dynamic Currency Conversion with a Third

Party Provider

This section describes how to include Dynamic Currency Conversion (DCC)

data from a third party DCC provider in your requests for CyberSource credit
Note card services. This section covers transaction processing after DCC. For
information about DCC, contact your DCC provider.
For information about the DCC service that is provided by CyberSource for
card-not-present transactions on FDC Nashville Global and FDMS South, see
Dynamic Currency Conversion for First Data Using the Simple Order API.

Services:
 Authorization
 Authorization reversal
 Capture
 Credit

Processors:
 FDC Nashville Global—only for card-present transactions
 SIX—only for card-present transactions

Card types:
 Visa
 Mastercard

DCC converts a foreign customer’s purchase from your local pricing currency to the
customer’s billing currency. This functionality can help you improve or create business
relationships with customers who prefer to make purchases in their own currency.

Requirement and Limitations

To include DCC data from a third party provider:

 Contact your acquirer to register for this feature.

 Contact CyberSource Customer Support to have your account configured for this
feature.

Credit Card Services Using the Simple Order API | September 2019 133
 Chapter 5 Optional Features

 You must meet the payment card company rules for DCC. Contact your acquirer for
details. For example, you might need to:

 Provide the customer with a receipt that shows the amount in the local pricing
currency, the amount in the billing currency, the rate of exchange used to convert
the order amount, and the DCC markup.

 Have the customer sign an acknowledgment that the customer had a choice to
pay in the local pricing currency and that the choice of currency is final.

When you use DCC for an order, you cannot split the order into multiple shipments.

Terminology
Table 36 DCC Terminology

Term Definition
Billing currency Currency in which the card is denominated and in which transactions
or are posted to the customer’s account.
converted currency
Converted amount Amount of the transaction, denominated in the customer’s billing
currency.
Exchange rate Factor used to convert an amount in one currency to an amount in
another currency.
Local pricing currency Selling currency that you use for pricing your goods and in which you
usually submit transactions for processing.
Original amount Amount of the transaction, denominated in your local pricing
currency.

Examples
See the examples for DCC in Card-Present Processing Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 134
 Chapter 5 Optional Features

Authorizing a Payment

The value for the purchaseTotals_originalAmount field must always be in

your local pricing currency.
Important
Except for the original amount, all amounts for the order must be in the
converted currency. This requirement includes the total payment amount and
any tax amounts or surcharge amounts that you send to CyberSource. Use
the exchange rate from your DCC provider to convert these amounts from
your local pricing currency to the customer’s billing currency.

For information about creating an authorization request, see "Creating an Authorization

Request," page 41. Include the following DCC fields in your authorization request:

 dcc_dccIndicator: set this field to 1. When you include DCC data in your authorization
request and do not set this field to 1, CyberSource rejects the request.

 dcc_referenceNumber: unique identifier generated by the DCC provider.

 item_#_unitPrice or purchaseTotals_grandTotalAmount: converted amount in your

customer’s billing currency.

 purchaseTotals_currency: currency code for your customer’s billing currency.

 purchaseTotals_exchangeRate: exchange rate.

 purchaseTotals_exchangeRateTimeStamp: exchange rate timestamp in GMT in this

format: YYYYMMDDhhmmss

 purchaseTotals_foreignAmount: converted amount in your customer’s billing currency.

 purchaseTotals_foreignCurrency: currency code for your customer’s billing currency.

 purchaseTotals_originalAmount: original amount in your local pricing currency.

 purchaseTotals_originalCurrency: currency code for your local pricing currency.

For details about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 135
 Chapter 5 Optional Features

Reversing an Authorization
Do not include any DCC fields in a full authorization reversal request. When you
include DCC fields in the request, CyberSource ignores them. For full
Important authorization reversals, CyberSource uses the data from the original
authorization.

The value for the purchaseTotals_originalAmount field must always be in

your local pricing currency.
Important
Except for the original amount, all amounts for the order must be in the
converted currency. This requirement includes the total payment amount and
any tax amounts or surcharge amounts that you send to CyberSource. Use
the exchange rate from your DCC provider to convert these amounts from
your local pricing currency to the customer’s billing currency.

For information about creating an authorization reversal request, see "Creating a Full
Authorization Reversal Request," page 57.

Capturing an Authorization
Do not include any DCC fields in a capture request. When you include DCC
fields in the request, CyberSource ignores them. For captures, CyberSource
Important uses the data from the original authorization.

The value for the purchaseTotals_originalAmount field must always be in

your local pricing currency.
Important
Except for the original amount, all amounts for the order must be in the
converted currency. This requirement includes the total payment amount and
any tax amounts or surcharge amounts that you send to CyberSource. Use
the exchange rate from your DCC provider to convert these amounts from
your local pricing currency to the customer’s billing currency.

For information about creating a capture request, see "Creating a Capture Request,"
page 62.

Credit Card Services Using the Simple Order API | September 2019 136
 Chapter 5 Optional Features

Crediting the Payment

Do not include any DCC fields in a credit request. When you include DCC fields
in the request, CyberSource ignores them. For credits, CyberSource uses the
Important data from the original authorization.

The value for the purchaseTotals_originalAmount field must always be in

your local pricing currency.
Important
Except for the original amount, all amounts for the order must be in the
converted currency. This requirement includes the total payment amount and
any tax amounts or surcharge amounts that you send to CyberSource. Use
the exchange rate from your DCC provider to convert these amounts from
your local pricing currency to the customer’s billing currency.

To credit a payment for a transaction that uses DCC, request a follow-on credit. For
information about creating a credit request, see "Creating a Credit Request," page 79.
DCC is not supported for stand-alone credits. When you include DCC fields in a request
for a stand-alone credit, CyberSource ignores them.

Encoded Account Numbers

Services:
 Authorization
 Credit

Processor:
 Chase Paymentech Solution’s Credit Card Encryption program

Depending on your type of business, you might be eligible to acquire from an issuing bank
a list of the customers who have payment cards issued by that bank. The list does not
include the customers’ payment card numbers, but instead includes encoded account
numbers. Some processors refer to this type of program as issuer encryption and to the
numbers as encrypted account numbers. This type of program is designed to protect
customer information according to the provisions of the Gramm-Leach-Bliley Act.

When processing a payment or credit for one of these customers, you use the encoded
account number instead of the customer’s payment card number. The issuing bank then
matches the encoded account number to the customer’s payment card number when
processing the payment.

You must contact your processor to obtain the information required for the Credit Card
Encryption program and you must have a relationship with the bank in order to acquire
their list of customers.

Credit Card Services Using the Simple Order API | September 2019 137
 Chapter 5 Optional Features

Final Authorization Indicator

Services:
 Authorization
 Incremental authorization

Processors:
 Barclays

 Chase Paymentech Solutions—Mastercard and Maestro (International) only. Chase

Paymentech Solutions does not support this feature for Maestro (UK Domestic).

 CyberSource through VisaNet

 Elavon

 Elavon Americas—Mastercard only.

 FDC Compass

 FDC Nashville Global

 FDI Australia

 FDMS Nashville

 GPN

 HBoS

 HSBC

 Lloyds-OmniPay

 LloydsTSB Cardnet

 OmniPay Direct. The supported acquirers are:

 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 OmniPay-Ireland—Mastercard only. OmniPay-Ireland does not support Maestro

(International) or Maestro (UK Domestic).

 SIX

Credit Card Services Using the Simple Order API | September 2019 138
 Chapter 5 Optional Features

 Streamline

 TSYS Acquiring Solutions

 Worldpay VAP—Worldpay VAP was previously called Litle.

CyberSource does not take any action to support this feature on Worldpay VAP. The
processor sets the indicator.

Card types:
 Mastercard
 Maestro (International)
 Maestro (UK Domestic)
 Co-badged Mastercard and mada as described in "mada Debit Cards," page 24. You
must identify the card type as Mastercard. Supported only on CyberSource through
VisaNet.

This feature supports a mandate from Mastercard. The purpose of the mandate is to
ensure that a customer’s funds are available when there is a risk that the order will not be
fulfilled.

For an authorization with an amount greater than zero, Mastercard recommends that you
indicate whether the authorization is a final authorization, a preauthorization, or an
undefined authorization.

Final Authorizations
For a final authorization:

 Authorization amount is greater than zero.

 Authorization amount is the final amount that the customer agrees to pay.

 Authorization should not be cancelled after it is approved except when a system

failure occurs.

 Authorization must be submitted for capture within seven calendar days of its request.

 Capture amount and currency must be the same as the authorization amount and
currency.

 Chargeback protection is in effect for seven days following the authorization.

Credit Card Services Using the Simple Order API | September 2019 139
 Chapter 5 Optional Features

Preauthorizations
For a preauthorization:

 Authorization amount is greater than zero.

 Authorization amount can be an estimate when the final amount is unknown, which is
typical for hotel, auto rental, e-commerce, and restaurant transactions.

 Authorization must be submitted for capture within 30 calendar days of its request.

 When you do not capture the authorization, you must reverse it.

In the U.S., Canada, Latin America, and Asia Pacific, Mastercard charges
an additional fee for a preauthorization that is not captured and not
Note reversed.
In Europe, Russia, Middle East, and Africa, Mastercard charges fees for
all preauthorizations.

 Chargeback protection is in effect for 30 days following the authorization.

Undefined Authorizations

Undefined authorizations are supported only in the U.S., Canada, Latin

America, and Asia Pacific. They are not supported in Europe, Russia, Middle
Note East, and Africa.

Undefined authorizations are not supported on the following processors:

 Chase Paymentech Solutions
Note
 Elavon Americas
 FDC Compass
 FDC Nashville Global
 FDI Australia
 FDMS Nashville
 SIX

For an undefined authorization:

 Authorization amount is greater than zero.

 Authorization amount can be different from the final transaction amount.

Credit Card Services Using the Simple Order API | September 2019 140
 Chapter 5 Optional Features

 Authorization should not be cancelled after it is approved except when a system

failure occurs.

 Authorization must be submitted for capture within seven calendar days of its request.

 When you do not capture the authorization, you must reverse it; otherwise,
Mastercard charges an additional fee for the transaction.

 Chargeback protection is in effect for seven days following the authorization.

An authorization is undefined when you set the default authorization type in

your CyberSource account to undefined and do not include the
Note authIndicator field in the authorization request. To set the default
authorization type in your CyberSource account, contact CyberSource
Customer Support.

Unmarked Authorizations

Unmarked authorizations are supported only on the following processors:

 Chase Paymentech Solutions
Note
 CyberSource through VisaNet
 Elavon Americas
 FDC Compass
 FDC Nashville Global
 FDI Australia
 FDMS Nashville
 HBoS
 Lloyds-OmniPay
 LloydsTSB Cardnet
 Streamline
 SIX

For an unmarked authorization:

 CyberSource does not set a mark or indicator for the type of authorization in the
request that is sent to the processor.

 Authorization amount is greater than zero.

 Authorization amount can be different from the final transaction amount.

Credit Card Services Using the Simple Order API | September 2019 141
 Chapter 5 Optional Features

 Your acquirer processes an unmarked authorization as a final authorization, a

preauthorization, or an undefined authorization. Contact your acquirer to learn how
they process unmarked authorizations.

An authorization is unmarked when the default authorization type is not set in

your CyberSource account and you do not include the authIndicator field in
Note the authorization request. To set the default authorization type in your
CyberSource account, contact CyberSource Customer Support.

To indicate whether an authorization is a final authorization or a

preauthorization:

Step 1 Include the authIndicator field in your authorization request. See "Request Fields,"
page 243, for the field description.

Step 2 For a final authorization on a processor that supports merchant-initiated transactions, your
authorization request must include subsequent authorization fields as described in
"Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF) Transactions,"
page 173.

The authIndicator field is included in the reply message for the following processors:
 Chase Paymentech Solutions
 CyberSource through VisaNet
 FDC Compass
 FDC Nashville Global
 FDI Australia
 FDMS Nashville

Forced Captures
Service:
 Authorization

Processors:
 AIBMS
 American Express Direct
 Asia, Middle East, and Africa Gateway
 Chase Paymentech Solutions

Credit Card Services Using the Simple Order API | September 2019 142
 Chapter 5 Optional Features

 CyberSource through VisaNet. The supported acquirers are:

 Banco Safra
 Bank Sinarmas (Omise Ltd.)
 BC Card Co., Ltd.
 Citibank Malaysia
 CTBC Bank Ltd.
 Sumitomo Mitsui Card Co.
 Vietnam Technological and Commercial Joint-stock Bank

 Elavon Americas
 FDC Nashville Global
 FDMS Nashville
 FDMS South
 GPN
 JCN Gateway
 OmniPay Direct. The supported acquirers are:
 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 TSYS Acquiring Solutions

Forced captures are not supported for Comercio Latino and CyberSource Latin
American Processing.
Note CyberSource Latin American Processing is the name of a specific processing
connection that CyberSource supports. In the CyberSource API
documentation, CyberSource Latin American Processing does not refer to the
general topic of processing in Latin America. The information in this note is for
the specific processing connections called Comercio Latino and CyberSource
Latin American Processing. It is not for any other Latin American processors
that CyberSource supports.

Credit Card Services Using the Simple Order API | September 2019 143
 Chapter 5 Optional Features

A forced capture occurs when you process an authorization outside the CyberSource
system but then capture the order through CyberSource.

To perform a forced capture:

After you process the authorization outside the CyberSource system, request the
CyberSource authorization and capture services at the same time as described in
"Creating an Authorization Request," page 41, and "Creating a Capture Request,"
page 62:

 Include the request fields that are required for the authorization.

 Include these fields in the request:

ccAuthService_authType=verbal

ccAuthService_verbalAuthCode= the authorization code you received in the

response for the authorization that was processed outside the CyberSource system

 No additional fields are required for the capture.

For the American Express card type on FDMS South, you must include the
ccCaptureService_posData and ccCaptureService_transactionID fields in the capture
request to support the CAPN requirements. Obtain the values for these fields from the
response for the authorization that was processed outside the CyberSource system.

Full-Financial Transactions
See "Least-Cost Routing (LCR)," page 164 and "Single-Message Processing," page 76.

Google Pay
See Google Pay Using the Simple Order API.

Guaranteed Exchange Rates

See "Multi-Currency Service," page 185.

Credit Card Services Using the Simple Order API | September 2019 144
 Chapter 5 Optional Features

Installment Payments
Services:
 Authorization
 Capture—only on CyberSource through VisaNet and FDC Nashville Global

Processors and card types:

 See the following table.

Table 37 Processors That Support Installment Payments

Processors Payment Card Types

American Express Direct American Express
See "Installment Payments on American Express Direct,"
page 148.
Chase Paymentech Solutions Visa
See "Installment Payments on Chase Paymentech Solutions
and FDC Compass," page 150.
Cielo Visa, Mastercard, American Express, Diners Club, JCB, Elo,
Aura
On Cielo, installment payments are not supported for debit
transactions.
See "Installment Payments on Processors in Latin America,"
page 159.
Comercio Latino Visa, Mastercard, American Express, Discover, Diners Club,
JCB, Elo, Aura, Hipercard
To enable installment payments, contact CyberSource
Customer Support to have your account configured for this
feature. On Comercio Latino, the acquirer Banorte requires
installment payments be submitted as an automatic capture.
See "Automatic Captures," page 40.
See "Installment Payments on Processors in Latin America,"
page 159.
CyberSource Latin American Visa
Processing
See "Installment Payments on Processors in Latin America,"
page 159.

Note CyberSource Latin American Processing is the name

of a specific processing connection that CyberSource
supports. In the CyberSource API documentation,
CyberSource Latin American Processing does not refer to
the general topic of processing in Latin America.

Credit Card Services Using the Simple Order API | September 2019 145
 Chapter 5 Optional Features

Table 37 Processors That Support Installment Payments (Continued)

Processors Payment Card Types

CyberSource through VisaNet Visa, Mastercard, American Express
Note Not all card types are supported for all acquirers.
The supported acquirers are:
 Arab African International Bank (AAIB)
 Asia Commercial Bank (ACB)
 Auckland Savings Bank (ASB)
 Australia and New Zealand Banking Group Limited
(ANZ)
 Axis Bank Ltd. of India
 Banco Nacional de México (Banamex)
 Banco Safra
 Bangkok Bank Ltd.
 Bank of Ayudhya (BAY)
 Bank of China (BOC)
 Bank Sinarmas (Omise Ltd.)
 Banque Pour Le Commerce Exterieur Lao (BCEL)
 BC Card Co., Ltd.
 Cathay United Bank (CUB)
 Citibank Malaysia
 Citibank Hongkong and Macau
 Commercial Bank of Qatar
 CrediMax (Bahrain)
 CTBC Bank Ltd.
 First Data Merchant Solutions in Brunei
 First Data Merchant Solutions in Hong Kong
 First Data Merchant Solutions in Malaysia
 First Data Merchant Solutions in Singapore
 Habib Bank Ltd. (HBL)
 HDFC Bank Ltd. of India
 Mashreq
 National Bank of Abu Dhabi (NBAD)
 Overseas Chinese Banking Corp (OCBC)
 Promerica in Honduras and Nicaragua
 Taishin Bank Ltd.
(continued)

Credit Card Services Using the Simple Order API | September 2019 146
 Chapter 5 Optional Features

Table 37 Processors That Support Installment Payments (Continued)

Processors Payment Card Types

 United Overseas Bank (UOB) in Singapore and
Vietnam
 United Overseas Bank (UOB) in Thailand
 Vantiv
 Vietcombank
 VietinBank
 Vietnam Technological and Commercial Joint-stock
Bank
 Wing Hang Bank
 Wing Lung Bank
See "Installment Payments on CyberSource through
VisaNet," page 150.
FDC Compass Visa
See "Installment Payments on Chase Paymentech Solutions
and FDC Compass," page 150.
FDC Nashville Global Visa, Discover, Diners Club, JCB (US Domestic)
For JCB cards, “US Domestic” means that the currency is
USD and your location is the U.S., Puerto Rico, Guam, U.S.
Virgin Islands, or Northern Mariana Islands.
See "Installment Payments on FDC Nashville Global,"
page 158.
FDI Australia Visa, Mastercard
See "Installment Payments on FDI Australia," page 159.
FDMS Nashville Visa
See "Installment Payments on Other Processors," page 161.
FDMS South Visa
See "Installment Payments on Other Processors," page 161.
Getnet Visa, Mastercard, American Express, Elo, Hipercard
On Getnet, installment payments are not supported for debit
transactions.
See "Installment Payments on Processors in Latin America,"
page 159.
OmniPay-Ireland Visa
OmniPay-Ireland is the See "Installment Payments on Other Processors," page 161.
CyberSource name for HSBC
International.

Credit Card Services Using the Simple Order API | September 2019 147
 Chapter 5 Optional Features

Table 37 Processors That Support Installment Payments (Continued)

Processors Payment Card Types

Rede Visa, Mastercard, American Express, Diners Club, JCB, Elo,
Hipercard
On Rede, installment payments are not supported for debit
transactions.
See "Installment Payments on Processors in Latin America,"
page 159.
Software Express Supported acquirer: Getnet
Support card types: Visa, Mastercard
See "Installment Payments on Processors in Latin America,"
page 159.
TSYS Acquiring Solutions Visa
See "Installment Payments on Other Processors," page 161.
Worldpay VAP Visa
Worldpay VAP was previously See "Installment Payments on Other Processors," page 161.
called Litle.

Installment Payments on American Express Direct

The customer pays for goods or services using an installment plan agreed upon by the
customer and you. The following table describes the types of installment payments that
American Express Direct supports.

Table 38 Types of Installment Payments on American Express Direct

Type of Installment Payments Features

Issuer installments  You send one transaction to American Express.
American Express calls this  American Express charges the amount to the
arrangement a deferred payment customer in installments.
plan.
 You receive one payment from American Express.
Merchant installments  You send one transaction to American Express.
American Express calls this  American Express charges the amount to the
arrangement Plan N. customer in installments.
 You receive payment from American Express in
installments.

Credit Card Services Using the Simple Order API | September 2019 148
 Chapter 5 Optional Features

The following table lists the countries and regions for which CyberSource supports
installment payments on American Express Direct.

Table 39 Country-Specific Information for Installment Payments on American

Express Direct

Country or Region Notes

Argentina  Issuer installments and merchant installments are supported.
 The currency for your installment transactions must be ARS.
Asia Pacific  Only issuer installments are supported. Merchant installments are
not supported.
Australia  Only issuer installments are supported. Merchant installments are
not supported.
Mexico  Issuer installments and merchant installments are supported.
 The currency for your installment transactions must be MXN.
 The purchase amount must be 250 MXN or more.

When you submit an installment transaction that does not meet the American
Express Direct requirements for installment payments, American Express
Important Direct processes the transaction as a regular, non-installment transaction.

Before submitting installment transactions:

 Contact American Express Direct to have your account configured for this feature.
 Contact CyberSource Customer Support to have your account configured for this
feature.

To indicate that a transaction on American Express Direct is an

installment payment:

Step 1 You must include the installment_totalCount field in your authorization request.

Step 2 You can include the optional ccAuthService_commerceIndicator field in your

authorization request. Set it to any valid value except recurring or recurring_
internet. For information about the commerce indicator values, see Appendix I,
"Commerce Indicators," on page 477.

Step 3 You must include the installment_planType field in your authorization request if the
corresponding value is not set in your CyberSource account. If this value is set in your
CyberSource account, you can include the field in your authorization request to override
the value in your CyberSource account.

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 149
 Chapter 5 Optional Features

Installment Payments on Chase Paymentech

Solutions and FDC Compass
The customer pays for goods or services using an installment plan agreed upon by the
customer and you.

To indicate that a transaction on Chase Paymentech Solutions or FDC

Compass is an installment payment:

Step 1 Set ccAuthService_commerceIndicator to install.

Step 2 Include the following required fields in your authorization request:

 invoiceHeader_merchantDescriptor
 invoiceHeader_merchantDescriptorContact

For information about these fields, see Merchant Descriptors Using the Simple Order API.

Step 3 Include subsequent authorization fields as described in "Merchant-Initiated Transactions

(MITs) and Credentials-on-File (COF) Transactions," page 173.

Step 4 You can include the following optional fields in your authorization request:
 installment_sequence
 installment_totalCount

For information about these fields, see Appendix A, "API Fields," on page 240.

Installment Payments on CyberSource through

VisaNet

Overview
Installment payments, which are called parcelados and parcelas in Brazil, are a common
way to pay for purchases made with payment cards. When a customer pays in
installments, the entire payment amount is authorized and captured at the time of the
purchase, but the payment is settled in increments over a period of time. Each incremental
settlement is an installment payment.

Before you can accept installment payments, you and your acquirer must agree on the
maximum number of installments you can accept, which can be different for each card
type.

For customers, installment payments provide greater purchasing power and lower impact
on their monthly budget. For you, offering installment payments at checkout typically
increases the number of successfully completed purchases by 50%.

Credit Card Services Using the Simple Order API | September 2019 150
 Chapter 5 Optional Features

Types of Funding
There are two standard types of funding for installment payments:
 Issuer-funded installments
 Merchant-funded installments

There are two additional types of funding for installment payments in Brazil:
 Co-branded merchant financed
 Issuer merchant co-financed

CyberSource through VisaNet supports all four types of funding. CyberSource through
VisaNet only enables the processing of installment payments. It has no role in setting the
terms for the installments.

Issuer-Funded Installment Payments

The customer pays for goods or services using an installment plan agreed upon by the
customer and their issuing bank. The issuer controls how the customer's account is
debited. Your account is credited for the entire amount in a single transaction. The issuer
assumes the risk and establishes credit rates and fees that are charged to the customer.
The customer pays the funding cost, which is a fee for paying in installments.

In Brazil, a Crediario is a special type of issuer-funded installment payment plan that

enables the customer to request information about the terms of the installment plan before
approving the installment payments.

Merchant-Funded Installment Payments

The customer pays for goods or services using an installment plan agreed upon by you
and the customer. The issuer controls how the customer's account is debited. Your
account is credited periodically for partial amounts as the customer's account is debited.
You assume the risk and establish the credit rate and fees that are charged to the
customer.

Co-Branded Merchant Financed Installment Payments

You and the issuer determine the terms for this kind of installment plan. The funding varies
depending on the agreement between you, the issuer, and the customer. This funding
method is available only for Mastercard installment payments in Brazil.

Issuer Merchant Co-Financed Installment Payments

The issuer creates the installment plan. You and the issuer determine the service fees that
the customer pays to you and the issuer. The acquirer is paid in full while the issuer is paid
in installments by the customer. You or the customer pay the funding cost, which is a fee
for paying in installments. This funding method is available only for Mastercard installment
payments in Brazil.

Credit Card Services Using the Simple Order API | September 2019 151
 Chapter 5 Optional Features

Installment Payments on CyberSource through VisaNet in Brazil

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with Mastercard in Brazil:

Step 1 You must include the following fields in your authorization or capture request:
 installment_planType
 installment_totalCount

Step 2 When creating an authorization request, you must include subsequent authorization fields
as described in "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on CyberSource through VisaNet is a

Crediario installment payment with Visa in Brazil:

Step 1 Inquire about Crediario eligibility for the customer by requesting the authorization service.
Include the following required fields in the authorization request:
 eligibilityInquiry—set to Crediario.
 installment_amount
 installment_firstInstallmentDate
 installment_frequency
 installment_sequence
 installment_totalAmount
 installment_totalCount
 purchaseTotals_grandTotalAmount—set to 0.

Step 2 The issuer determines whether the customer is eligible for Crediario installment payments.
If the customer is eligible, the authorization reply includes the following fields:
 installment_additionalCosts
 installment_additionalCostsPercentage
 installment_amountFunded
 installment_amountRequestedPercentage
 installment_annualFinancingCost
 installment_annualInterestRate
 installment_expenses
 installment_expensesPercentage

Credit Card Services Using the Simple Order API | September 2019 152
 Chapter 5 Optional Features

 installment_fees
 installment_feesPercentage
 installment_insurance
 installment_insurancePercentage
 installment_monthlyInterestRate
 installment_taxes
 installment_taxesPercentage

Step 3 Use the values in the authorization reply to display the installment payment terms to the
customer. The customer decides whether to accept the terms.

Step 4 If the customer accepts the terms, request an installment payment:

a Request the authorization service. Include the following required fields in the
authorization request:
 installment_planType
 installment_totalAmount
 installment_totalCount
 Subsequent authorization fields as described in "Merchant-Initiated Transactions
(MITs) and Credentials-on-File (COF) Transactions," page 173.

You can include the following optional fields in the authorization request:
 installment_amount
 installment_firstInstallmentDate
 installment_frequency
 installment_sequence

b Request the capture service. Include the following required fields in the capture
request:
 installment_additionalCosts
 installment_additionalCostsPercentage
 installment_amountFunded
 installment_amountRequestedPercentage
 installment_annualFinancingCost
 installment_annualInterestRate
 installment_expenses
 installment_expensesPercentage
 installment_fees
 installment_feesPercentage
 installment_insurance
 installment_insurancePercentage
 installment_monthlyInterestRate

Credit Card Services Using the Simple Order API | September 2019 153
 Chapter 5 Optional Features

 installment_planType
 installment_taxes
 installment_taxesPercentage
 installment_totalAmount
 installment_totalCount

You can include the following optional fields in the capture request:
 installment_amount
 installment_firstInstallmentDate
 installment_frequency
 installment_sequence

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on CyberSource through VisaNet is a

non-Crediario installment payment with Visa in Brazil:

Step 1 You must include the following fields in your authorization or capture request:
 installment_planType
 installment_totalCount

Step 2 When creating an authorization request, you must include subsequent authorization fields
as described in "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

Step 3 You can include the following optional field in your authorization or capture request:
 installment_paymentType

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 154
 Chapter 5 Optional Features

Installment Payments on CyberSource through VisaNet in

Croatia

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with Mastercard in Croatia:

Step 1 You must include the following fields in your authorization or capture request:
 billTo_merchantTaxID
 installment_planType

Step 2 When creating an authorization request, you must include subsequent authorization fields
as described in "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

For information about these fields, see Appendix A, "API Fields," on page 240.

Installment Payments on CyberSource through VisaNet in

Georgia (Sakartvelo)

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with Mastercard in Georgia:

Step 1 You must include the following fields in your authorization or capture request:
 installment_amount
 installment_firstInstallmentAmount
 installment_monthlyInterestRate
 installment_planType
 installment_totalCount

Step 2 When creating an authorization request, you must include subsequent authorization fields
as described in "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 155
 Chapter 5 Optional Features

Installment Payments on CyberSource through VisaNet in

Greece

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with Mastercard in Greece:

Step 1 You must include the following fields in your authorization or capture request:
 installment_gracePeriodDuration
 installment_gracePeriodDurationType
 installment_planType
 installment_totalCount

Step 2 When creating an authorization request, you must include subsequent authorization fields
as described in "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 156
 Chapter 5 Optional Features

Installment Payments on CyberSource through VisaNet in Other

Countries

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with American Express:

Step 1 Include installment_planType or installment_totalCount in your authorization or

capture request.

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with Mastercard:

Step 1 You must include the following fields in your authorization or capture request:
 installment_paymentType
 installment_planType

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on CyberSource through VisaNet is an

installment payment with Visa:

Step 1 Set ccAuthService_commerceIndicator to install or install_internet:

 install—U.S. transaction or non-U.S. mail order / telephone order (MOTO)

transaction

 install_internet—non-U.S. e-commerce (Internet) transaction

Step 2 Include installment_planType in your authorization request.

Step 3 The authorization request must include subsequent authorization fields as described in
"Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF) Transactions,"
page 173.

Credit Card Services Using the Simple Order API | September 2019 157
 Chapter 5 Optional Features

Step 4 You can include the following optional fields in your authorization request:
 installment_amount
 installment_frequency
 installment_sequence
 installment_totalAmount
 installment_totalCount

For information about these fields, see Appendix A, "API Fields," on page 240.

Installment Payments on FDC Nashville Global

The customer pays for goods or services using an installment plan agreed upon by the
customer and you.

To indicate that a transaction on FDC Nashville Global is an

installment payment:

Step 1 When you request the authorization service, set ccAuthService_commerceIndicator to

install.

Step 2 When you request the capture service, include the following required fields in the request:
 installment_sequence
 installment_totalCount

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 158
 Chapter 5 Optional Features

Installment Payments on FDI Australia

The customer pays for goods or services using an installment plan agreed upon by the
customer and you.

To indicate that a transaction on FDI Australia is an installment

payment:

Step 1 In the authorization request for the first installment payment, set ccAuthService_
commerceIndicator to install.

Step 2 In the authorization requests for the subsequent installment payments, include these
fields:

 ccAuthService_commerceIndicator—set to install.

 subsequentAuthTransactionID—set to the value returned in the ccAuthReply_

paymentNetworkTransactionID field for the previous authorization in the series.

For information about these fields, see Appendix A, "API Fields," on page 240.

Installment Payments on Processors in Latin

America
The customer pays for goods or services using an installment plan agreed upon by the
customer and you.

Before submitting installment transactions, contact CyberSource Customer Support to

have your account configured for this feature.

To indicate that a transaction on Cielo or Comercio Latino is an

installment payment:

Step 1 You must include the installment_totalCount field in your authorization request.

Step 2 You can include the optional ccAuthService_commerceIndicator field in your

authorization request. Set it to one of the following values:

 install—U.S. transaction or non-U.S. mail order / telephone order (MOTO)

transaction

 internet—e-commerce transaction. This is the default value that CyberSource uses

when you do not include the commerce indicator field in the request.

Credit Card Services Using the Simple Order API | September 2019 159
 Chapter 5 Optional Features

 spa—Mastercard Identity Check transaction.

 vbv—Visa Secure transaction.

Step 3 You must include the installment_planType field in your authorization request if the
corresponding value is not set in your CyberSource account. If this value is set in your
CyberSource account, you can include the field in your authorization request to override
the value in your CyberSource account.

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on CyberSource Latin American

Processing is an installment payment:

CyberSource Latin American Processing is the name of a specific processing

connection that CyberSource supports. In the CyberSource API
Note documentation, CyberSource Latin American Processing does not refer to the
general topic of processing in Latin America. The information in this section is
for the specific processing connection called CyberSource Latin American
Processing. It is not for any other Latin American processors that CyberSource
supports.

Step 1 Set ccAuthService_commerceIndicator to install.

Step 2 For a transaction in Brazil, you can include the following optional fields in your
authorization request:
 installment_planType
 installment_totalCount

For information about these fields, see Appendix A, "API Fields," on page 240.

Step 3 For a transaction in Mexico, installment payments are supported, but conditions vary, so
contact CyberSource Customer Support or your CyberSource account manager.

Credit Card Services Using the Simple Order API | September 2019 160
 Chapter 5 Optional Features

To indicate that a transaction on Getnet or Software Express is an

installment payment:

Step 1 You must include the following fields in your authorization request:
 installment_planType
 installment_totalCount

For information about these fields, see Appendix A, "API Fields," on page 240.

To indicate that a transaction on Rede is an installment payment:

Step 1 You must include the installment_totalCount field in your authorization request.

For information about this field, see Appendix A, "API Fields," on page 240.

Installment Payments on Other Processors

The customer pays for goods or services using an installment plan agreed upon by the
customer and you.

To indicate that a transaction on any other supported processor is an

installment payment:

Step 1 Set ccAuthService_commerceIndicator to install.

Step 2 If your processor supports merchant-initiated transactions, your authorization request

must include subsequent authorization fields as described in "Merchant-Initiated
Transactions (MITs) and Credentials-on-File (COF) Transactions," page 173.

Step 3 Include the following required fields in your authorization request:

 installment_sequence
 installment_totalCount

For information about these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 161
 Chapter 5 Optional Features

Japanese Payment Options

Services:
 Authorization
 Capture—supported only on JCN Gateway
 Credit—supported only on JCN Gateway

Processors:
 CyberSource through VisaNet—the only supported acquirer is Sumitomo Mitsui Card
Co.
 JCN Gateway

Card types:
 Visa
 Mastercard—supported only on JCN Gateway
 American Express—supported only on JCN Gateway
 Diners Club—supported only on JCN Gateway
 JCB—supported only on JCN Gateway

In addition to standard single payments, Japanese acquirers support the payment options
listed in Table 40, "Japanese Payment Options," on page 163.

Before using one of these payment options, you must sign a contract with your acquirer.
Additionally, the funding cycle could differ when using these options. Contact your account
provider for details about contracts and funding cycles.

Some acquirers might not support all of these payment options. Additionally, a card holder
must sign a contract with an issuing bank before using one of these payment options.
Therefore, not all card holders take advantage of these payment options. Confirm
payment option availability with your account provider and the card holder before
implementing one of these payment options.

CyberSource accepts requests with these payment options independently of

your agreements with acquirers. When you submit a request with one of these
Important payment options but do not have the necessary contracts and agreements in
place, an error might not occur until the acquirer processes the settlement file.

The following table lists the API fields required for each payment option. For details about
these fields, see Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 162
 Chapter 5 Optional Features

Table 40 Japanese Payment Options

Payment Option Required Fields

1 (default): Single payment No Japanese payment option fields are required. When
you omit jpo_paymentMethod from a request,
CyberSource processes the request as a single
payment.
2: Bonus payment jpo_paymentMethod
4: Installment payment jpo_installments
jpo_paymentMethod
5. Revolving payment jpo_paymentMethod
6: Combination of bonus payment jpo_installments
and installment payment jpo_paymentMethod

Additional Japanese Payment Option Fields

In addition to the fields listed in the preceding table, CyberSource supports the following
fields for transactions in Japan:
 jpo_businessNameAlphanumeric
 jpo_businessNameJapanese
 jpo_businessNameKatakana
 jpo_firstBillingMonth—supported only for JPO payment methods 4 and 6

For details about these fields, see Appendix A, "API Fields," on page 240.

CyberSource also supports the following fields for card-present transactions in Japan:
 jpo_jccaTerminalID
 jpo_jis2TrackData

For details about these fields, see Card-Present Processing Using the Simple Order API.

Verbal Authorizations
When you submit a capture request with a verbal authorization, if the initial authorization
included Japanese payment option fields, the capture request must include the same
Japanese payment option fields.

Stand-Alone Credits
When you perform a stand-alone credit for a transaction that included Japanese payment
option fields, the request for the stand-alone credit must include the same Japanese
payment option fields.

Credit Card Services Using the Simple Order API | September 2019 163
 Chapter 5 Optional Features

On CyberSource through VisaNet, stand-alone credits are supported only for JPO
payment method 1.

When a request for a stand-alone credit is made with JCN Gateway, most acquirers make
inquiries about the purpose of such a request. CyberSource recommends using follow-on
credits instead of stand-alone credits whenever possible.

Additional Information
For more information about the Japanese payment options, contact Customer Support of
CyberSource KK (Japan).

JCB J/Secure
See "Payer Authentication," page 186.

Least-Cost Routing (LCR)

See also "Single-Message Processing," page 76.

Note

Processors:
 FDI Australia—supported only for AUD
 Worldpay VAP

Least-cost routing offers the lowest routing costs available. When you request LCR, the
processor first determines whether LCR is possible for the transaction, and, if it is
possible, the processor uses single-message processing to accomplish LCR.

There are important differences between single-message processing and dual-

message processing:
Important  With single-message processing, an authorization+capture request
results in a full-financial transaction, which moves funds immediately.

 With single-message processing, the capture amount and authorization

amount are the same.

 Several services and features are not supported for single-message

processing because they are not applicable or could create reconciliation
problems. See "Unsupported Features," page 167.

Credit Card Services Using the Simple Order API | September 2019 164
 Chapter 5 Optional Features

To request least-cost routing for all authorization+capture

transactions:

Step 1 Contact CyberSource Customer Support to enable LCR for your account.

Step 2 For each authorization+capture request:

a Request the authorization and capture services at the same time:

 Include the request fields that are required for an authorization. See "Authorizing
a Payment," page 38.

 If the transaction does not include any optional capture features, such as Level II
data, no additional fields are required for the capture. See "Capturing an
Authorization," page 61.

 If the transaction includes an optional capture feature, include the fields that are
needed for the feature.

b The reply message from CyberSource includes authorization and capture results. The
authorization amount and capture amount are the same.

c To find out whether the processor used LCR for the transaction, see the daily
processor report.

Step 3 To turn off LCR for an authorization+capture transaction, set ccAuthService_

leastCostRouting to false in the authorization+capture request.

For a description of the LCR field, see Appendix A, "API Fields," on page 240.

For an example of an LCR request and reply, see:

 Name-value pair examples: "Worldpay VAP Examples," page 426
 XML examples: "Worldpay VAP Examples," page 460

To request least-cost routing for one transaction:

Step 1 Request the authorization and capture services at the same time:

 Include the request fields that are required for an authorization. See "Authorizing a
Payment," page 38.

 If the transaction does not include any optional capture features, such as Level II data,
no additional fields are required for the capture. See "Capturing an Authorization,"
page 61.

Credit Card Services Using the Simple Order API | September 2019 165
 Chapter 5 Optional Features

 If the transaction includes an optional capture feature, include the fields that are
needed for the feature.

 Set ccAuthService_leastCostRouting to true.

The reply message from CyberSource includes authorization and capture results. The
authorization amount and capture amount are the same.

Step 2 To find out whether the processor used LCR for the transaction, see the daily processor
report.

For a description of the LCR field, see Appendix A, "API Fields," on page 240.

For an example of an LCR request and reply, see:

 Name-value pair examples: "Worldpay VAP Examples," page 426
 XML examples: "Worldpay VAP Examples," page 460

Partial Authorizations
If the transaction is enabled for partial authorization, the processor can process a partial
amount instead of the entire requested amount. For details about partial authorizations,
see "Partial Authorizations," page 105.

Supported Features
The following features are supported for least-cost routing and single-message
processing on Worldpay VAP:
 AVS. See "Address Verification System (AVS)," page 88.
 Balance responses. See "Balance Responses," page 111.
 Card type indicators. See "Card Type Indicators (CTIs)," page 130.
 Credits. See "Crediting a Payment," page 78.
 CVN. See "Card Verification Numbers (CVNs)," page 97.
 Debit cards. See Chapter 4, "Features for Debit Cards and Prepaid Cards," on
page 105.
 Merchant descriptors. See Merchant Descriptors Using the Simple Order API.
 Payer authentication. See "Payer Authentication," page 186.
 Prepaid cards. See Chapter 4, "Features for Debit Cards and Prepaid Cards," on
page 105.

Credit Card Services Using the Simple Order API | September 2019 166
 Chapter 5 Optional Features

Unsupported Features
The following features are not supported for least-cost routing and single-message
processing:
 Authorization reversal after void
 Full authorization reversals
 Multiple partial captures
 Stand-alone authorizations
 Stand-alone captures
 Verbal authorizations
 Voids

Level II Data
See Level II and Level III Processing Using the Simple Order API.

Level III Data

See Level II and Level III Processing Using the Simple Order API.

Mastercard Bill Payments

Services:
 Authorization

Processor:
 CyberSource through VisaNet

This feature is supported only in Brazil.

Note

Mastercard provides a Bill Payment program that enables customers to use their
Mastercard cards to pay their bills. When you participate in this program, Mastercard
requests that you flag the bill payments so they can be easily identified. To flag these
transactions, include the billPaymentType field in your transaction requests. Do not use
this indicator if you have not signed up with Mastercard to participate in the program.

Credit Card Services Using the Simple Order API | September 2019 167
 Chapter 5 Optional Features

Mastercard Expert Monitoring Solutions

(EMS)
Service:
 Authorization

Processor:
 CyberSource through VisaNet

Mastercard Expert Monitoring Solutions (EMS) provides a predictive, behavior-based

fraud score in real time during authorizations for card-not-present (CNP) transactions on
cards issued in the U.S. EMS compares a customer’s transaction data to their transaction
behavior history and a regional CNP fraud detection model. The resulting score indicates
the likelihood that the transaction is fraudulent.

To use EMS, call CyberSource Customer Support to have your account enabled for this
feature. After your account is enabled, Mastercard performs EMS on all your CNP
authorization requests for U.S.-issued Mastercard cards. For these requests,
CyberSource returns the fraud score in the ccAuthReply_emsTransactionRiskScore
field. For information about this field, see Appendix A, "API Fields," on page 240.

Mastercard Identity Check

See "Payer Authentication," page 186.

Mastercard Send
Mastercard Send is one of the networks supported by CyberSource Payouts.

See Payouts Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 168
 Chapter 5 Optional Features

Masterpass
Services:
 Authorization
 Credit—Chase Paymentech Solutions and CyberSource through VisaNet only

Processors:
 Chase Paymentech Solutions
 CyberSource through VisaNet
 Elavon Americas
 OmniPay Direct. The supported acquirers are:
 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Getnet
 Rede
 SIX

To indicate that a request is for a Masterpass transaction:

Before requesting Masterpass transactions, contact CyberSource Customer Support to

have your account configured for this feature.

On Chase Paymentech Solutions or CyberSource through VisaNet, include the wallet_

type field in your authorization or credit request.

On OmniPay Direct, include the following fields in your authorization request:

 wallet_type
 paymentSolution

For details about these fields, see Appendix A, "API Fields," on page 240.

Merchant Descriptors
See Merchant Descriptors Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 169
 Chapter 5 Optional Features

Merchant-Initiated Reversals and Voids

Services:
 Authorization
 Capture
 Credit

Processors:
 Chase Paymentech Solutions
 CyberSource through VisaNet
 Elavon Americas
 FDC Nashville Global
 OmniPay Direct—merchant-initiated voids are not supported.
 Rede
 SIX

When you do not receive a reply message after sending a request to CyberSource, this
feature enables you to reverse or void the transaction that you requested.

To use merchant-initiated reversals and voids on CyberSource

through VisaNet:

Step 1 Include the merchantTransactionIdentifier field in your original request for an

authorization, capture, sale, follow-on credit, or stand-alone credit.

The value of the merchant transaction ID must be unique for 60 days.

Note

Step 2 When you do not receive a reply message for your original transaction request, reverse or
void the original transaction as described in the following table.

Transaction to Procedure
Reverse or Void
Authorization Request the full authorization reversal service as described in "Creating a
Full Authorization Reversal Request," page 57. Instead of including the
request ID in your request message, include the
merchantTransactionIdentifier field. The merchant transaction ID links
your reversal request to your original request.
Capture or sale Request the void service as described in "Creating a Void Request,"
page 86. Instead of including the request ID in your request message,
include the merchantTransactionIdentifier field. The merchant
transaction ID links your void request to your original request.
CyberSource automatically handles authorization reversals on capture
and sale requests.

Credit Card Services Using the Simple Order API | September 2019 170
 Chapter 5 Optional Features

Transaction to Procedure
Reverse or Void
Credit Request the void service as described in "Creating a Void Request,"
page 86. Instead of including the request ID in your request message,
include the merchantTransactionIdentifier field. The merchant
transaction ID links your void request to your original request.

Step 3 If the original transaction failed, the reply message for the reversal or void request
includes the following fields:
 originalTransaction_amount
 originalTransaction_reasonCode

To use merchant-initiated reversals on OmniPay Direct:

Step 1 Include the merchantTransactionIdentifier field in your original request for an

authorization, capture, or sale.

The value of the merchant transaction ID must be unique for 60 days.

Note

Step 2 When you do not receive a reply message for your original transaction request, reverse
the original transaction as described in the following table.

Transaction to Procedure
Reverse or Void
Authorization Request the full authorization reversal service as described in
"Creating a Full Authorization Reversal Request," page 57. Instead of
including the request ID in your request message, include the
merchantTransactionIdentifier field. The merchant transaction ID
links your reversal request to your original request.
Capture or sale 1 Request the void service as described in "Creating a Void
Request," page 86. Include the request ID in your request
message.
2 Request the authorization reversal service as described in
"Creating a Full Authorization Reversal Request," page 57. Instead
of including the request ID in your request message, include the
merchantTransactionIdentifier field. The merchant transaction ID
links your reversal request to your original request.
Credit Request the void service as described in "Creating a Void Request,"
page 86. Include the request ID in your request message.

Credit Card Services Using the Simple Order API | September 2019 171
 Chapter 5 Optional Features

Step 3 If the original transaction failed, the reply message for the reversal request includes the
following fields:
 originalTransaction_amount
 originalTransaction_reasonCode

To use merchant-initiated reversals and voids on all other

processors:

Step 1 Include the merchantTransactionIdentifier field in your original request for an

authorization, capture, sale, follow-on credit, or stand-alone credit.

The value of the merchant transaction ID must be unique for 60 days.

Note

Step 2 When you do not receive a reply message for your original transaction request, reverse or
void the original transaction as described in the following table.

Transaction to Procedure
Reverse or Void
Authorization Request the full authorization reversal service as described in "Creating a Full
Authorization Reversal Request," page 57. Instead of including the request ID in your
request message, include the merchantTransactionIdentifier field. The merchant
transaction ID links your reversal request to your original request.
Capture or sale 1 Request the void service as described in "Creating a Void Request," page 86. Instead of
including the request ID in your request message, include the
merchantTransactionIdentifier field. The merchant transaction ID links your void
request to your original request.
2 Request the authorization reversal service as described in "Creating a Full Authorization
Reversal Request," page 57. Instead of including the request ID in your request
message, include the merchantTransactionIdentifier field. The merchant transaction
ID links your reversal request to your original request.
Credit Request the void service as described in "Creating a Void Request," page 86. Instead of
including the request ID in your request message, include the
merchantTransactionIdentifier field. The merchant transaction ID links your void request
to your original request.

Step 3 If the original transaction failed, the reply message for the reversal or void request
includes the following fields:
 originalTransaction_amount
 originalTransaction_reasonCode

Credit Card Services Using the Simple Order API | September 2019 172
 Chapter 5 Optional Features

Merchant-Initiated Transactions (MITs) and

Credentials-on-File (COF) Transactions
This section describes how to perform a merchant-initiated transaction (MIT)
yourself. For information about letting Token Management Service (TMS)
Note perform MITs for you, see:
 https://www.cybersource.com/content/dam/cybersource/MIT-mandate-
FAQ.pdf

 https://www.cybersource.com/content/dam/cybersource/Token_
Management_Service_Stored_Credential_Mandate_FAQ.pdf

Service:
 Authorization

Processors and card types:

 See the following table.

Table 41 Processors That Support MITs and COF Transactions

Processor Card Types Scenarios

AIBMS Visa CIT with COF
Mastercard
All MIT scenarios except:
 Incremental authorization
 Installment payment
Barclays Visa CIT with COF
All MIT scenarios except
installment payment
Chase Paymentech Solutions Visa CIT with COF
Mastercard
All MIT scenarios except:
Discover
 Delayed charge
 Incremental authorization
 No-show charge
 Resubmission
CyberSource through VisaNet Visa CIT with COF
Mastercard
All MIT scenarios
Elavon Americas Visa CIT with COF
All MIT scenarios except
installment payment

Credit Card Services Using the Simple Order API | September 2019 173
 Chapter 5 Optional Features

Table 41 Processors That Support MITs and COF Transactions (Continued)

Processor Card Types Scenarios

FDC Compass Visa CIT with COF
Mastercard
All MIT scenarios except:
Discover
 Delayed charge
 Incremental authorization
 No-show charge
FDC Nashville Global Visa CIT with COF
Mastercard
All MIT scenarios except:
Discover
 Delayed charge
 Incremental authorization
 No-show charge
 Resubmission
GPN Visa CIT with COF
All MIT scenarios except
installment payment
HBoS Visa CIT with COF
All MIT scenarios except
installment payment
HSBC Visa CIT with COF
All MIT scenarios except
installment payment
Lloyds-OmniPay Visa CIT with COF
All MIT scenarios except
installment payment
LloydsTSB Cardnet Visa CIT with COF
All MIT scenarios except
installment payment
OmniPay Direct—supported for all Visa CIT with COF
OmniPay Direct acquirers. See Mastercard
All MIT scenarios except:
Table 2, page 21, for the list of
OmniPay Direct acquirers.  Incremental authorization
 Installment payment
Rede Visa CIT with COF
All MIT scenarios

Credit Card Services Using the Simple Order API | September 2019 174
 Chapter 5 Optional Features

Table 41 Processors That Support MITs and COF Transactions (Continued)

Processor Card Types Scenarios

SIX Visa CIT with COF
All MIT scenarios except
installment payment
Streamline Visa CIT with COF
All MIT scenarios except
installment payment

Credit Card Services Using the Simple Order API | September 2019 175
 Chapter 5 Optional Features

Overview
Figure 4 illustrates the relationships between kinds of stored credential transactions.

Figure 4 Stored Credentials, CITs, and MITs

Obtaining a Customer’s Credentials

When you obtain a customer’s credentials for the first time, you must do the following:

 Obtain the customer’s consent for storing the payment credentials and disclose the
reason for storing them.

 If an amount is due, submit a payment transaction, which can be an authorization or a

full-financial transaction.

Credit Card Services Using the Simple Order API | September 2019 176
 Chapter 5 Optional Features

 You must include the subsequentAuthFirst field in the request to identify this
transaction as a COF transaction. Set the value for this field to true.

 You must include the ccAuthService_commerceIndicator field in the request.

Set the value for this field to internet or to a payer authentication value. For
information about payer authentication, see "Payer Authentication," page 186.

 For information about authorizations, see "Authorizing a Payment," page 38. For
information about full-financial transactions, see "Least-Cost Routing (LCR),"
page 164, or "Single-Message Processing," page 76.

 If no amount is due, request a zero amount authorization.

 You must include the subsequentAuthFirst field in the request to identify this
transaction as a COF transaction. Set the value for this field to true.

 You must include the ccAuthService_commerceIndicator field in the request.

Set the value for this field to internet or to a payer authentication value. For
information about payer authentication, see "Payer Authentication," page 186.

 See "Zero Amount Authorizations," page 231.

 If the payment transaction or zero amount authorization fails, do not store the
credentials, and do not use the credentials for subsequent COF transactions.

Cardholder-Initiated Transactions with Credentials

on File
Card types:
 Discover
 Mastercard
 Visa

A cardholder-initiated transaction is a transaction that uses payment information provided

by the customer. A credentials-on-file CIT occurs when a customer orders an item online
and instructs you to use the payment information that is saved in your system.

To create an authorization request for a COF CIT:

Step 1 Include the subsequentAuthStoredCredential field in the authorization request. Set the
value for this field to true.

Step 2 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Credit Card Services Using the Simple Order API | September 2019 177
 Chapter 5 Optional Features

Merchant-Initiated Transactions
A merchant-initiated transaction is an authorization that you initiate when the customer is
not present. An MIT uses payment information from a previous CIT but is conducted
without the active participation of the customer. There are two main types of MITs. See:
 Industry Practice MITs, page 178
 Standing Instruction MITs, page 182

Industry Practice MITs

An industry practice transaction is a one-time follow-up to a CIT that could not be
completed with one transaction. Not every industry practice MIT is performed with a stored
credential. When you store the credential for a single transaction or a single purchase, it is
not considered as a stored credential transaction.

Delayed Charge
Card type:
 Visa

A delayed charge is associated with an agreement between you and the customer for
services rendered. Delayed charges are typical for lodging transactions and auto rental
transactions.

To create an authorization request for a delayed charge:

Step 1 Include the following required fields in the authorization request:

 subsequentAuth—set the value for this field to true.
 subsequentAuthReason—set the value for this field to 2.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization.

Step 2 If the payment information is COF information, include the following field in the
authorization request:
 subsequentAuthStoredCredential—set the value for this field to true.

Step 3 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Credit Card Services Using the Simple Order API | September 2019 178
 Chapter 5 Optional Features

Incremental Authorization
Card type:
 Visa

The kind of incremental authorization described in this section is not the same
as the incremental authorization service. For information about the incremental
Note authorization service, see "Incremental Authorizations," page 45.

An incremental authorization is a continuation of a purchase when the originally approved

amount is modified to accommodate additional services. Incremental authorizations are
typical for lodging transactions and auto rental transactions.

To create a request for an incremental authorization:

Step 1 Include the following required fields in the authorization request:

 subsequentAuth—set the value for this field to true.
 subsequentAuthReason—set the value for this field to 4.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization.

Step 2 See "Creating an Authorization Request," page 41, for information about additional
required fields.

No-Show Charge
Card type:
 Visa

A no-show charge occurs when you and a customer have an agreement for a purchase,
but the customer does not meet the terms of the agreement. No-show charges are
typically used in hotels and motels for a single-night stay.

Credit Card Services Using the Simple Order API | September 2019 179
 Chapter 5 Optional Features

To create an authorization request for a no-show charge:

Step 1 Include the following required fields in the authorization request:

 subsequentAuth—set the value for this field to true.
 subsequentAuthReason—set the value for this field to 4.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization.

Step 2 If the payment information is COF information, include the following field in the
authorization request:
 subsequentAuthStoredCredential—set the value for this field to true.

Step 3 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Reauthorization
Card types:
 Discover
 Visa

You can reauthorize a payment when the completion of the original order extends beyond
the authorization validity time limit set by Visa. Two common reauthorization scenarios
are:

 Split or delayed shipment. A split or delayed shipment occurs when some of the goods
that were ordered are not available for shipment at the time of purchase. When you
ship goods after the authorization validity time limit set by Visa, you must perform a
separate authorization to ensure that customer funds are available.

 Extended stay for hotels, car rentals, and cruise lines. When a hotel stay, car rental, or
cruise extends beyond the authorization validity time limit set by Visa, you must
perform a separate authorization to ensure that customer funds are available.

Credit Card Services Using the Simple Order API | September 2019 180
 Chapter 5 Optional Features

To create a reauthorization request:

Step 1 Include the following required fields in the authorization request:

 subsequentAuth—set the value for this field to true.

 subsequentAuthOriginalAmount—set the value for this field to the amount for the
original authorization. Required only for Discover.

 subsequentAuthReason—set the value for this field to 3.

 subsequentAuthTransactionID—set the value for this field to the network transaction

identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization.

Step 2 If the payment information is COF information, include the following field in the
authorization request:
 subsequentAuthStoredCredential—set the value for this field to true.

Step 3 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Step 4 When the reauthorization is for a split shipment, see "Split Shipments," page 220, for
additional information.

Step 5 When the reauthorization is for a partial authorization, see "Partial Authorizations,"
page 105.

Resubmission
Card types:
 Visa

A resubmission occurs when you cannot obtain an authorization for a customer-initiated

purchase. A resubmission is valid only when the original authorization was declined for
insufficient funds and only when the goods or services were already delivered to the
customer.

Credit Card Services Using the Simple Order API | September 2019 181
 Chapter 5 Optional Features

To create an authorization request for a resubmission:

Step 1 Include the following required fields in the authorization request:

 subsequentAuth—set the value for this field to true.
 subsequentAuthReason—set the value for this field to 1.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization.

Step 2 If the payment information is COF information, include the following field in the
authorization request:
 subsequentAuthStoredCredential—set the value for this field to true.

Step 3 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Standing Instruction MITs

A standing instruction is one transaction in a series of repeated transactions or a one-time,
unscheduled transaction that uses COF payment information.

Installment Payment
Card type:
 Discover
 Mastercard
 Visa

An installment payment is a COF transaction in a series of payments that you bill to a

customer over a period of time agreed to by you and the customer for a single purchase of
goods or services. The agreement enables you to charge a specific amount at specified
intervals.

Credit Card Services Using the Simple Order API | September 2019 182
 Chapter 5 Optional Features

To create an authorization request for an installment payment:

Step 1 Charge the first installment payment as a CIT. Include the following field in the
authorization request:
 subsequentAuth—set the value for this field to true.

Step 1 Charge subsequent installment payments on a regular basis. Include the following fields in
each authorization request:
 ccAuthService_commerceIndicator—set the value for this field to install.
 subsequentAuth—set the value for this field to true.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization. Optional for Mastercard.

Step 2 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Step 3 See "Installment Payments," page 145, for additional information about installment
payments.

Recurring Payment
Card types:
 Discover
 Mastercard
 Visa

A recurring payment is a COF transaction in a series of payments that you bill to a

customer at fixed, regular intervals not to exceed one year between transactions. The
series of recurring payments is the result of an agreement between you and the customer
for the purchase of goods or services that are provided at regular intervals.

To create an authorization request for a recurring payment:

Step 1 Charge the first recurring payment as a CIT. Include the following field in the authorization
request:
 subsequentAuthFirst—set the value for this field to true.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization. Optional for Mastercard.

Credit Card Services Using the Simple Order API | September 2019 183
 Chapter 5 Optional Features

Step 2 Charge subsequent recurring payments regularly. Include the following fields in each
authorization request:
 ccAuthService_commerceIndicator—set the value for this field to recurring.
 subsequentAuthFirst—set the value for this field to true.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization. Optional for Mastercard.

Step 3 See "Creating an Authorization Request," page 41, for information about additional
required fields.

Step 4 See "Recurring Payments," page 207, for additional information about recurring
payments.

Unscheduled Credential-on-File (COF) Transaction

Card type:
 Discover
 Mastercard
 Visa

An unscheduled COF transaction uses stored payment information for a fixed or variable
amount that does not occur on a scheduled or regular basis. An account top-up is one
kind of unscheduled COF.

To create an authorization request for an unscheduled COF

transaction:

Step 1 Charge the first payment. Include the following fields in the authorization request:

 ccAuthService_commerceIndicator—set the value for this field to internet or to a

payer authentication value. For information about payer authentication, see "Payer
Authentication," page 186.

 subsequentAuthFirst—set the value for this field to true.

Step 2 Charge subsequent payments. Include the following fields in each authorization request:
 subsequentAuth—set the value for this field to true.
 subsequentAuthStoredCredential—set the value for this field to true.
 subsequentAuthTransactionID—set the value for this field to the network transaction
identifier that was returned in the ccAuthReply_paymentNetworkTransactionID
field in the reply message for the original authorization. Optional for Mastercard.

Credit Card Services Using the Simple Order API | September 2019 184
 Chapter 5 Optional Features

Step 3 See "Creating an Authorization Request," page 41, for information about additional
required fields.

API Field Descriptions

For descriptions of the fields in the preceding scenarios, see Appendix A, "API Fields," on
page 240.

Micropayments
Services:
 Authorization
 Capture
 Credit

Processors:
 Most of the card types and processors that CyberSource supports

Micropayments are payments for less than one unit in the transaction’s currency.

Multi-Currency Service
Services:
 Authorization
 Capture
 Credit

Processor:
 Chase Paymentech Solutions

If you sell your products in multiple countries, you might want to list your product prices in
your customers’ local currencies. The CyberSource multi-currency service provides
current, guaranteed exchange rates, which enables customers to pay using their local
currencies while enabling you to do business and settle transactions in your desired
currency.

For more information about the CyberSource multi-currency service, see the
Multicurrency Service for Chase Paymentech Solutions Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 185
 Chapter 5 Optional Features

Network Tokenization
See "Payment Network Tokenization," page 204.

Partial Shipments
See "Split Shipments," page 220.

Payer Authentication

Before you implement payer authentication, you must contact CyberSource

Customer Support to have your account configured for this feature.
Important

When you request an authorization using a supported card type and a supported
processor, you can include payer authentication data in the request. You can use the
CyberSource payer authentication services to add Visa Secure, JCB J/Secure™,
ProtectBuy, Mastercard® Identity Check™, RuPay PaySecure, or American Express
SafeKey support to your web site without running additional software on your own server.
The following table lists the cards supported for each type of payer authentication. For
descriptions of the CyberSource payer authentication services, see Payer Authentication
Using the Simple Order API.

Table 42 Supported Card Types for Payer Authentication

Type of Payer Card Types

Authentication
American Express SafeKey American Express
JCB J/Secure JCB
Mastercard Identity Check  Mastercard
 Co-badged Mastercard and mada as described in "mada
Debit Cards," page 24. You must identify the card type as
Mastercard. Supported only on CyberSource through
VisaNet.
 Maestro (International)
 Maestro (UK Domestic)
ProtectBuy  Diners Club
 Discover
RuPay PaySecure RuPay

Credit Card Services Using the Simple Order API | September 2019 186
 Chapter 5 Optional Features

Table 42 Supported Card Types for Payer Authentication

Type of Payer Card Types

Authentication
Visa Secure  Visa
 Co-badged Visa and mada as described in "mada Debit
Cards," page 24. You must identify the card type as Visa.
Supported only on CyberSource through VisaNet.

American Express SafeKey

Service:
 Authorization

Processors:
 American Express Direct: mandatory for transactions that originate in Singapore.
 CyberSource through VisaNet
 Elavon Americas
 FDC Nashville Global
 JCN Gateway

American Express SafeKey (AESK) authenticates the Customer during an online

purchase and protects payment information as it is transmitted over the Internet.

To request the authorization of an AESK transaction:

Step 1 Add the fields in the following table to your ccAuthService request. The values for these
fields are in the reply from the validate authentication service payerAuthValidateService.
When you request payerAuthValidateService and ccAuthService together, the data is
automatically passed from one service to the other.
The authorization service returns a raw response code and a mapped response code:

 The raw response code is the value returned by the processor. CyberSource returns
this value in the ccAuthReply_cavvResponseCodeRaw field.

 The mapped response code is the predefined CyberSource value that corresponds to
the raw response code. CyberSource returns this value in the ccAuthReply_
cavvResponseCode field. Appendix D, "American Express SafeKey Response
Codes," on page 467 describes the mapped response codes.

Credit Card Services Using the Simple Order API | September 2019 187
 Chapter 5 Optional Features

Table 43 Request Fields for American Express SafeKey

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
CAVV—cardholder authentication verification value. ccAuthService_cavv payerAuthValidateReply_
This value is a transaction identifier generated by the cavv
issuing bank during American Express SafeKey
payer authentication. This value is required.
ECI—electronic commerce indicator. This value is ccAuthService_ payerAuthValidateReply_
required. Possible values: commerceIndicator commerceIndicator
 aesk: Successful AESK transaction.
 aesk_attempted: AESK transaction was
attempted but not authenticated.
XID—transaction identifier. This value is optional. ccAuthService_xid payerAuthValidateReply_xid

JCB J/Secure
Service:
 Authorization

Processors:
 CyberSource through VisaNet
 Elavon Americas
 Ingenico ePayments
 JCN Gateway
 SIX
 TSYS Acquiring Solutions

JCB J/Secure authenticates the customer by adding a password identification step to the
online shopping process. For details about signing up for and using J/Secure, contact your
acquiring bank or go to the JCB web site:

http://www.jcb-global.com/

To request the authorization of a JCB J/Secure transaction:

Step 1 Add the fields listed in Table 46, "Request Fields for Visa Secure, JCB J/Secure, and
ProtectBuy," on page 199 to your ccAuthService request. The values for these fields are
in the reply from the validate authentication service payerAuthValidateService. When
you request payerAuthValidateService and ccAuthService together, the data is
automatically passed from one service to the other.

Credit Card Services Using the Simple Order API | September 2019 188
 Chapter 5 Optional Features

Mastercard Identity Check

Service:
 Authorization

Processors That Support Mastercard Identity Check 1.0:

 AIBMS
 Asia, Middle East, and Africa Gateway
 Atos
 Barclays
 Chase Paymentech Solutions
 Cielo
 Comercio Latino
 Credit Mutuel-CIC
 CyberSource Latin American Processing: Mastercard Identity Check is an emerging
feature in the Latin American region. It is not fully supported in all countries. Contact
CyberSource Customer Support for details.

CyberSource Latin American Processing is the name of a specific

processing connection that CyberSource supports. In the CyberSource
Note API documentation, CyberSource Latin American Processing does not
refer to the general topic of processing in Latin America.

 CyberSource through VisaNet

 Elavon
 Elavon Americas
 FDC Compass
 FDC Germany
 FDI Australia
 FDC Nashville Global
 FDMS Nashville
 FDMS South
 Getnet
 GPN
 HBoS
 HSBC: HSBC is the CyberSource name for HSBC U.K.
 Ingenico ePayments
 JCN Gateway
 LloydsTSB Cardnet
 Moneris

Credit Card Services Using the Simple Order API | September 2019 189
 Chapter 5 Optional Features

 OmniPay Direct. The supported acquirers are:

 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 OmniPay-Ireland: OmniPay-Ireland is the CyberSource name for HSBC International.

On OmniPay-Ireland, Mastercard Identity Check attempts are not

considered Identity Check transactions and are downgraded to non-
Note Identity Check transactions. CyberSource recommends that you migrate to
the OmniPay Direct processor to use the latest version of the Identity
Check feature.

 RBS WorldPay Atlanta

 Rede
 SIX
 Streamline
 TSYS Acquiring Solutions
 Worldpay VAP—Worldpay VAP was previously called Litle.

Processors That Support Mastercard Identity Check 2.0:

 CyberSource through VisaNet
 FDC Nashville Global
 OmniPay Direct. The supported acquirers are:
 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

Mastercard Identity Check adds security to online transactions by authenticating Identity

Check account holders for specific transactions. Identity Check generates a unique,
32-character transaction token, called the account authentication value (AAV), each time
an Identity Check-enabled account holder makes an online purchase. The AAV binds the
account holder to a specific transaction. Identity Check transactions use the universal
cardholder authentication field (UCAF) as a standard to collect and pass AAV data. For
details about signing up for and using Identity Check or UCAF, contact your acquiring bank
or go to the Mastercard web site:

http://www.mastercard.com/

Credit Card Services Using the Simple Order API | September 2019 190
 Chapter 5 Optional Features

To request the authorization of a Mastercard Identity Check

transaction:

Step 1 Add the fields in Table 44, "Request Fields for Mastercard Identity Check," to your
ccAuthService request. The values for these fields are in the reply from the validate
authentication service payerAuthValidateService. When you request
payerAuthValidateService and ccAuthService together, the data is automatically
passed from one service to the other.

Table 44 Request Fields for Mastercard Identity Check

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
3D Secure Version—version of 3D Secure that was ccAuthService_ payerAuthEnrollReply_
used to process the Mastercard Identity Check paSpecificationVersion specificationVersion
transaction.
or
 Used only for these processors:
payerAuthValidateReply_
 CyberSource through VisaNet specificationVersion
 OmniPay Direct
 Always required.
 Examples: 1.0.2 or 2.0.0.
CAVV Algorithm—algorithm for generating the ccAuthService_ payerAuthValidateReply_
UCAF authentication data. cavvAlgorithm cavvAlgorithm
 Used only for these processors:
 Atos
 Ingenico ePayments when a third-party provider
authenticates the transaction
 Required when you include the UCAF
authentication data in your request.
 You must not include the CAVV algorithm value in
your request when the UCAF authentication data
is not included in your request or when your
processor is not Atos or Ingenico ePayments.
 Possible values:
0: HMAC (hash-based message authentication
code)
1: CVV
2: CVV with ATN
3: Mastercard SPA (secure payment algorithm)
Note Ingenico ePayments was previously called
Global Collect.

Credit Card Services Using the Simple Order API | September 2019 191
 Chapter 5 Optional Features

Table 44 Request Fields for Mastercard Identity Check (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
Directory Server Transaction ID—Transaction ID ccAuthService_ payerAuthEnrollReply_
generated by the Mastercard directory server during directoryServer directoryServerTransactionID
authentication. TransactionID
or
 Used only for these processors:
payerAuthValidateReply_
 CyberSource through VisaNet directoryServerTransactionID
 OmniPay Direct
 Required for Mastercard Identity Check 2.0
transactions.
 Example: f38e6948-5388-41a6-bca4-
b49723c19437.
ECI—electronic commerce indicator. ccAuthService_ payerAuthValidateReply_
commerceIndicator commerceIndicator
 Used for all processors that support Mastercard
Identity Check.
 Always required.
 Possible values for a Mastercard Identity Check
transaction:
 spa: Mastercard Identity Check transaction.
 spa_failure: Mastercard Identity Check
authentication failed. Available only for Elavon,
HSBC, and Streamline.
Note The ECI for all Mastercard Identity Check
transactions, including authentication attempts, must
be set to spa. Otherwise, the transactions will be
processed as non-Identity Check transactions.
ECI Raw—raw electronic commerce indicator. ccAuthService_eciRaw payerAuthValidateReply_
 Used for all processors that support Mastercard eciRaw
Identity Check.
 Required when the payer authentication validation
service returns a raw ECI value.
 Some processors require the raw ECI to
guarantee chargeback protection. Contact
CyberSource Customer Support for information
about your processor’s requirements.

Credit Card Services Using the Simple Order API | September 2019 192
 Chapter 5 Optional Features

Table 44 Request Fields for Mastercard Identity Check (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
PARes Status—payer authentication response ccAuthService_ payerAuthValidateReply_
status. paresStatus paresStatus
 Used only for these processors:
 Asia, Middle East, and Africa Gateway
 Atos
 Ingenico ePayments when a third-party provider
authenticates the transaction
 For Atos and Ingenico ePayments: required for a
successful Mastercard Identity Check transaction,
which is indicated when the UCAF collection
indicator is 2.
 For the Asia, Middle East, and Africa Gateway:
required unless all of the following are true:
 You are requesting the payer authentication and
the authorization in separate requests.
 This is a successful Mastercard Identity Check
transaction, which is indicated when the
commerce indicator is spa.
 The card is not enrolled, which is indicated
when the VERes enrolled status is not Y.
When all the preceding conditions are true, do
not include the PARes status in the
authorization request. If you do, CyberSource
sends the value to the processor without
modification. CyberSource does not decline the
transaction; declines are generated by the
processor.
 Possible values:
 Y: Customer was successfully authenticated.
 A: Proof of authentication attempt was
generated.
 N: Customer failed or cancelled authentication.
Transaction denied.
 U: Authentication not completed regardless of
the reason.
Note Ingenico ePayments was previously called
Global Collect.

Credit Card Services Using the Simple Order API | September 2019 193
 Chapter 5 Optional Features

Table 44 Request Fields for Mastercard Identity Check (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
UCAF Authentication Data—authentication data for ucaf_authenticationData payerAuthValidateReply_
the universal cardholder authentication field. ucafAuthenticationData
 Used for all processors that support Mastercard
Identity Check.
 Required when the UCAF collection indicator is 1,
2, or 5. Do not include UCAF authentication data
in the authorization request if the UCAF collection
indicator is not 1, 2, or 5.
Important Mastercard has indicated that an issuing
bank can downgrade an authorization request to a
non-secure transaction when the UCAF collection
indicator is 1 and UCAF authentication data is not
present. An issuing bank can choose not to settle a
downgraded Mastercard Identity Check transaction.
When UCAF authentication data is not present, set
the UCAF collection indicator to 0.
UCAF Collection Indicator—collection indicator for ucaf_collectionIndicator payerAuthValidateReply_
the universal cardholder authentication field. ucafCollectionIndicator
 Used for all processors that support Mastercard
Identity Check.
 Always required.
 Possible values:
 0: UCAF collection is not supported at your web
site.
 1: UCAF collection is supported at your web
site, and the UCAF was populated.
 2: UCAF collection is supported at your web
site and the UCAF was populated. This value
indicates a successful Mastercard Identity
Check transaction.
 5: UCAF collection is supported at your web
site, and the UCAF was populated based on the
risk assessment that the issuer performed. This
value is supported only for Masterpass
transactions.
 6: UCAF collection is supported at your web
site, and the UCAF was populated based on the
risk assessment that you performed. This value
is supported only for Masterpass transactions.

Credit Card Services Using the Simple Order API | September 2019 194
 Chapter 5 Optional Features

Table 44 Request Fields for Mastercard Identity Check (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
VERes Enrolled—verification response enrollment ccAuthService_ payerAuthEnrollReply_
status. veresEnrolled veresEnrolled
 Used only for the Asia, Middle East, and Africa
Gateway.
 Required for all payer authentication transactions.
 Possible values:
 Y: Authentication available.
 N: Customer not participating.
 U: Unable to authenticate regardless of the
reason.
XID—transaction identifier. Must be 28-character ccAuthService_xid payerAuthValidateReply_xid
base64 or 40-character hex binary.
 Used for all processors that support Mastercard
Identity Check.
 For Atos: required for a successful Mastercard
Identity Check transaction, which is indicated
when the UCAF collection indicator is 2.
 For all other processors: required when the payer
authentication validation service returns an XID
value.

ProtectBuy
Service:
 Authorization

Processor:
 SIX

ProtectBuy authenticates the customer by adding a password identification step to the

online shopping process. For details about signing up for and using ProtectBuy, contact
your acquiring bank or go to the ProtectBuy web site:

http://protectbuy.nnja.co/

Credit Card Services Using the Simple Order API | September 2019 195
 Chapter 5 Optional Features

To request the authorization of a ProtectBuy transaction:

Step 1 Add the fields listed in Table 46, "Request Fields for Visa Secure, JCB J/Secure, and
ProtectBuy," on page 199 to your ccAuthService request. The values for these fields are
in the reply from the validate authentication service payerAuthValidateService. When
you request payerAuthValidateService and ccAuthService together, the data is
automatically passed from one service to the other.

RuPay PaySecure
Service:
 Authorization

Processor:
 RuPay

RuPay PaySecure authenticates the customer during an online purchase and protects
payment information as it is transmitted over the Internet. See the Payer Authentication
RuPay Integration Guide.

To request the authorization of a RuPay PaySecure transaction:

Step 1 Add the fields in the following table to your ccAuthService request. The values for these
fields are in the reply from the payer authentication validate service
payerAuthValidateService. When you request payerAuthValidateService and
ccAuthService together, the data is automatically passed from one service to the other.

Table 45 Request Fields for RuPay PaySecure

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
CAVV—cardholder authentication verification value. ccAuthService_cavv payerAuthValidateReply_
This value is a transaction identifier generated by the cavv
issuing bank during RuPay PaySecure payer
authentication. This value is required.
ECI—electronic commerce indicator. This value is ccAuthService_ payerAuthValidateReply_
required. Possible value: commerceIndicator commerceIndicator
 rpy: Successful RuPay PaySecure transaction.
XID—transaction identifier. This value is required. ccAuthService_xid payerAuthValidateReply_xid

Credit Card Services Using the Simple Order API | September 2019 196
 Chapter 5 Optional Features

Visa Secure
Service:
 Authorization

Processors:
 AIBMS
 Asia, Middle East, and Africa Gateway
 Atos
 Barclays
 Chase Paymentech Solutions
 Cielo
 Comercio Latino
 Credit Mutuel-CIC
 CyberSource Latin American Processing: Visa Secure is an emerging feature in the
Latin American region. It is not fully supported in all countries. Contact CyberSource
Customer Support for details.

CyberSource Latin American Processing is the name of a specific

processing connection that CyberSource supports. In the CyberSource
Note API documentation, CyberSource Latin American Processing does not
refer to the general topic of processing in Latin America.

 CyberSource through VisaNet

 Elavon
 Elavon Americas
 FDC Compass
 FDC Germany
 FDI Australia
 FDC Nashville Global
 FDMS Nashville
 FDMS South
 Getnet
 GPN
 HBoS
 HSBC: HSBC is the CyberSource name for HSBC U.K.
 Ingenico ePayments
 JCN Gateway

Credit Card Services Using the Simple Order API | September 2019 197
 Chapter 5 Optional Features

 LloydsTSB Cardnet
 Moneris
 OmniPay Direct. The supported acquirers are:
 Bank of America Merchant Services
 Cardnet International
 First Data Merchant Solutions (Europe)
 Global Payments International Acquiring

 OmniPay-Ireland: OmniPay-Ireland is the CyberSource name for HSBC International.

 RBS WorldPay Atlanta
 Rede
 SIX
 Streamline
 TSYS Acquiring Solutions
 Worldpay VAP—Worldpay VAP was previously called Litle.

Visa Secure reduces the risk of unauthorized use of a payment card account. Visa Secure
enables you to verify a customer’s identity through the use of a password and provides
results to you in real time during the checkout process. For details about signing up for
and using Visa Secure, contact your acquiring bank or go to the Visa web site:

http://visa.com/

For Visa Secure transactions, use card type 001. Do not use card type 033. For
information about card type values, see Appendix G, "Card Types," on
Note page 473.

For Visa Checkout and Visa Secure Remote Commerce transactions, do not
map the Visa Secure data from the decrypt Visa Checkout data service reply
Note message to the payer authentication fields in the authorization request.
CyberSource maps the data for you. The transaction information that
CyberSource sends to the processor includes the Visa Secure data.

Credit Card Services Using the Simple Order API | September 2019 198
 Chapter 5 Optional Features

To request the authorization of a Visa Secure transaction:

Step 1 Add the fields listed in the following table to your ccAuthService request. The values for
these fields are in the reply from the validate authentication service
payerAuthValidateService. When you request payerAuthValidateService and
ccAuthService together, the data is automatically passed from one service to the other.
The authorization service returns a raw response code and a mapped response code:

 The raw response code is the value returned by the processor. CyberSource returns
this value in the ccAuthReply_cavvResponseCodeRaw field.

 The mapped response code is the predefined CyberSource value that corresponds to
the raw response code. CyberSource returns this value in the ccAuthReply_
cavvResponseCode field. Appendix T, "Visa Secure Response Codes," on page 505
describes the mapped response codes.

Table 46 Request Fields for Visa Secure, JCB J/Secure, and ProtectBuy

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
CAVV—cardholder authentication verification value. ccAuthService_cavv payerAuthValidateReply_
This value is a transaction identifier generated by the cavv
issuing bank during Visa Secure, JCB J/Secure, or
ProtectBuy payer authentication. Must be
28-character base64 or 40-character hex binary.
 Used for all processors that support Visa Secure,
JCB J/Secure, or ProtectBuy.
 Required when the commerce indicator is js, pb,
pb_attempted, vbv, or vbv_attempted.
 Optional when the commerce indicator is
js_attempted.
 For Visa Secure on FDC Nashville Global,
CyberSource sets this field to the value for the
transaction identifier (XID) if the XID is present in
the authorization request and the CAVV is not
present.

Credit Card Services Using the Simple Order API | September 2019 199
 Chapter 5 Optional Features

Table 46 Request Fields for Visa Secure, JCB J/Secure, and ProtectBuy (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
CAVV Algorithm—algorithm for generating the ccAuthService_ payerAuthValidateReply_
CAVV. cavvAlgorithm cavvAlgorithm
 Used only for these processors:
 Atos
 Ingenico ePayments when a third-party provider
authenticates the transaction
 Required when you include the CAVV in your
request.
 You must not include the CAVV algorithm value in
your request when the CAVV is not included in
your request or when your processor is not Atos or
Ingenico ePayments.
 Possible values:
0: HMAC (hash-based message authentication
code)
1: CVV
2: CVV with ATN
Note Ingenico ePayments was previously called
Global Collect.
ECI—electronic commerce indicator. ccAuthService_ payerAuthValidateReply_
commerceIndicator commerceIndicator
 Used for all processors that support Visa Secure,
JCB J/Secure, or ProtectBuy.
 Always required.
 Possible values for a Visa Secure, JCB J/Secure,
or ProtectBuy transaction:
 js: Successful JCB J/Secure transaction.
 js_attempted: JCB J/Secure transaction
was attempted but not authenticated.
 pb: Successful ProtectBuy transaction.
 pb_attempted: ProtectBuy transaction was
attempted but not authenticated.
 vbv: Successful Visa Secure transaction.
 vbv_attempted: Visa Secure transaction
was attempted but not authenticated.
 vbv_failure: Visa Secure authentication
failed. Available only for HSBC and Streamline.

Credit Card Services Using the Simple Order API | September 2019 200
 Chapter 5 Optional Features

Table 46 Request Fields for Visa Secure, JCB J/Secure, and ProtectBuy (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
ECI Raw—raw electronic commerce indicator. ccAuthService_eciRaw payerAuthValidateReply_
eciRaw
 Used for all processors that support Visa Secure,
JCB J/Secure, or ProtectBuy.
 Required when the payer authentication validation
service returns a raw ECI value.
 Some processors require the raw ECI to
guarantee chargeback protection. Contact
CyberSource Customer Support for information
about your processor’s requirements.

Credit Card Services Using the Simple Order API | September 2019 201
 Chapter 5 Optional Features

Table 46 Request Fields for Visa Secure, JCB J/Secure, and ProtectBuy (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
PARes Status—payer authentication response ccAuthService_ payerAuthValidateReply_
status. paresStatus paresStatus
 Used only for these processors:
 Asia, Middle East, and Africa Gateway
 Atos
 Ingenico ePayments when a third-party provider
authenticates the transaction
 For Atos and Ingenico ePayments: required for a
successful Visa Secure transaction, which is
indicated when the commerce indicator is vbv.
 For the Asia, Middle East, and Africa Gateway:
required unless all of the following are true:
 You are requesting the payer authentication and
the authorization in separate requests.
 This is a successful or attempted Visa Secure
transaction, which is indicated when the
commerce indicator is vbv or
vbv_attempted.
 The card is not enrolled, which is indicated
when the VERes enrolled status is not Y.
When all the preceding conditions are true, do
not include the PARes status in the
authorization request. If you do, CyberSource
sends the value to the processor without
modification. CyberSource does not decline the
transaction; declines are generated by the
processor.
 Possible values:
 Y: Customer was successfully authenticated.
 A: Proof of authentication attempt was
generated.
 N: Customer failed or cancelled authentication.
Transaction denied.
 U: Authentication not completed regardless of
the reason.
Note Ingenico ePayments was previously called
Global Collect.

Credit Card Services Using the Simple Order API | September 2019 202
 Chapter 5 Optional Features

Table 46 Request Fields for Visa Secure, JCB J/Secure, and ProtectBuy (Continued)

Value and Requirements Request Field for the Get the Value from this
Authorization Service Payer Authentication
Reply Field
VERes Enrolled—verification response enrollment ccAuthService_ payerAuthEnrollReply_
status. veresEnrolled veresEnrolled
 Used only for the Asia, Middle East, and Africa
Gateway.
 Required for all payer authentication transactions.
 Possible values:
 Y: Authentication available.
 N: Customer not participating.
 U: Unable to authenticate regardless of the
reason.
XID—transaction identifier. Must be 28-character ccAuthService_xid payerAuthValidateReply_xid
base64 or 40-character hex binary.
 Used for all processors that support Visa Secure,
JCB J/Secure, or ProtectBuy.
 For Atos: required for a successful Visa Secure
transaction, which is indicated when the
commerce indicator is vbv.
 For all other processors: required when the
commerce indicator is js, pb, or vbv.
 Optional when the commerce indicator is
js_attempted, pb_attempted, or vbv_
attempted.
 For Visa Secure on FDC Nashville Global,
CyberSource sets the cardholder authentication
verification value (CAVV) field to the XID value if
the XID is present in the authorization request and
the CAVV is not present.

Credit Card Services Using the Simple Order API | September 2019 203
 Chapter 5 Optional Features

Payment Network Tokenization

Payment network tokenization and CyberSource payment tokenization are not

the same feature.
Note  With payment network tokenization, the token is created by a token
service provider and can be used throughout the financial network.
 With CyberSource payment tokenization, the token is created by
CyberSource and can be used only with CyberSource services.

See Payment Network Tokenization Using the Simple Order API.

Payment Tokenization
See "Token Management Service (TMS)," page 228.

Payouts
See Payouts Using the Simple Order API.

POS Transactions
See Card-Present Processing Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 204
 Chapter 5 Optional Features

Quasi-Cash
Services:
 Authorization
 Full authorization reversal
 Capture
 Credit
 Void

Processors:
 Atos: Full authorization reversals and automatic partial authorization reversals are not
supported for Atos.

 CyberSource through VisaNet. The supported acquirers are:

 Auckland Savings Bank (ASB)
 Australia and New Zealand Banking Group Limited (ANZ)
 Axis Bank Ltd. of India
 Banco Safra
 Bangkok Bank Ltd.
 Bank Sinarmas (Omise Ltd.)
 BC Card Co., Ltd.
 Cathay United Bank (CUB)
 Citibank Malaysia
 First Data Merchant Solutions in Brunei
 First Data Merchant Solutions in Hong Kong
 First Data Merchant Solutions in Malaysia
 First Data Merchant Solutions in Singapore
 Habib Bank Ltd. (HBL)
 HDFC Bank Ltd. of India
 Promerica in Honduras and Nicaragua
 Taishin Bank Ltd.
 United Overseas Bank (UOB) in Singapore and Vietnam
 Vantiv
 Vietnam Technological and Commercial Joint-stock Bank
 Westpac

 GPN
 TSYS Acquiring Solutions

Credit Card Services Using the Simple Order API | September 2019 205
 Chapter 5 Optional Features

Before processing quasi-cash transactions, contact CyberSource Customer Support to

have your account configured for this feature. If you have questions about the supported
card types, contact your processor.

A quasi-cash transaction is a cash-like transaction for the sale of items that are directly
convertible to cash, such as:
 Casino gaming chips
 Money orders
 Wire transfers

Automatic partial authorization reversals are supported for quasi-cash transactions. See
"Automatic Partial Authorization Reversals," page 69.

Recipients
Service:
 Authorization

Processors:
 Barclays
 Elavon
 HBoS
 LloydsTSB Cardnet
 Streamline

In the United Kingdom there is a regulation that permits customers to use a debit card to
pay outstanding debt for another person. This person is referred to as the payment
recipient. For example, a customer can pay the entire balance or part of the balance on a
recipient’s payment card or payday loan. To help reduce the high levels of fraud that occur
for these kinds of transactions, you must include information about the recipient in the
authorization request. The following fields are required in the United Kingdom for Visa
debit transactions that are characterized under merchant category code 6012:
 recipient_accountID
 recipient_dateOfBirth
 recipient_lastName
 recipient_postalCode

These fields are described in Appendix A, "API Fields," on page 240.

Credit Card Services Using the Simple Order API | September 2019 206
 Chapter 5 Optional Features

Recurring Billing
When you use Recurring Billing, you can process an authorization, capture, or credit by
using information that is stored in a subscription. CyberSource uses the subscription ID to
reference the subscription information in the CyberSource database. Instead of providing
all the information that is normally required for a transaction, you only need to provide the
following values:
 Merchant ID
 Merchant reference code
 Amount of the payment or credit
 Subscription ID

You can override most of the information stored in the subscription by including the
relevant API fields in the payment or credit request. For example, you could provide a
different billing or shipping address in the request. You cannot override the payment card
account number.

See Recurring Billing Using the Simple Order API.

Recurring Payments
Service:
 Authorization

Processors and card types:

 See the following table.

Table 47 Processors That Support Recurring Payments

Processors Payment Card Types

AIBMS Visa, Mastercard, Maestro (International)
American Express Brighton American Express
American Express Direct American Express
Asia, Middle East, and Africa Gateway Visa, Mastercard, American Express, Diners
Club, JCB
Atos Visa, Mastercard
Before processing recurring payments on Atos,
you must:
 Contact your acquirer to ensure that you are
permitted to accept recurring transactions.
 Contact Atos to have your account configured
to accept recurring transactions.

Credit Card Services Using the Simple Order API | September 2019 207
 Chapter 5 Optional Features

Table 47 Processors That Support Recurring Payments (Continued)

Processors Payment Card Types

Barclays Visa, Mastercard, JCB
Chase Paymentech Solutions Visa, Mastercard, American Express, Discover
Cielo Visa, Mastercard, American Express, Diners
Club, Discover, JCB, Maestro (International), Elo,
Aura
On Cielo, recurring payments are not supported
for debit transactions.
Comercio Latino Visa, Mastercard, American Express, Discover,
Diners Club, JCB, Elo, Aura, Hipercard
When processing transactions in Mexico, you
must include the billTo_customerID field in the
authorization. Before you request the
authorization you must inform the issuer of the
customer contract numbers in advance.
The supported acquirers are:
 Banorte—must be submitted as an automatic
capture. See "Automatic Captures," page 40.
 Cielo
Credit Mutuel-CIC Visa, Mastercard, Cartes Bancaires

Credit Card Services Using the Simple Order API | September 2019 208
 Chapter 5 Optional Features

Table 47 Processors That Support Recurring Payments (Continued)

Processors Payment Card Types

CyberSource through VisaNet Visa, Mastercard, American Express, Diners
Club, JCB, Discover
Note Not all card types are supported for all
acquirers.
The supported acquirers are:
 Arab African International Bank (AAIB)
 Asia Commercial Bank (ACB)
 Auckland Savings Bank (ASB)
 Australia and New Zealand Banking Group
Limited (ANZ)
 Axis Bank Ltd. of India
 Banco Nacional de México (Banamex)
 Banco Safra
 Bangkok Bank Ltd.
 Bank Muscat of Oman
 Bank of Ayudhya (BAY)
 Bank of China (BOC)
 Bank Sinarmas (Omise Ltd.)
 Banque Pour Le Commerce Exterieur Lao
(BCEL)
 BC Card Co., Ltd.
 Cathay United Bank (CUB)
 Citibank Hongkong and Macau
 Citibank Malaysia
 Citibank Singapore Ltd.
 Commercial Bank of Qatar
 CrediMax (Bahrain)
 CTBC Bank Ltd.
 First Data Merchant Solutions in Brunei
 First Data Merchant Solutions in Hong
Kong
 First Data Merchant Solutions in Malaysia
 First Data Merchant Solutions in Singapore
 Global Payments Asia Pacific
 Habib Bank Ltd. (HBL)
 HDFC Bank Ltd. of India
 I&M Bank
 ICICI of India
 Mashreq

Credit Card Services Using the Simple Order API | September 2019 209
 Chapter 5 Optional Features

Table 47 Processors That Support Recurring Payments (Continued)

Processors Payment Card Types

 National Bank of Abu Dhabi (NBAD)
 National Bank of Kuwait (NBK)
 Overseas Chinese Banking Corp (OCBC)
 Promerica in Honduras and Nicaragua
 Qatar National Bank (QNB Group)
 Sumitomo Mitsui Card Co.
 Taishin Bank Ltd.
 United Overseas Bank (UOB) in Singapore
and Vietnam
 Vantiv
 Vietcombank
 VietinBank
 Vietnam Technological and Commercial
Joint-stock Bank
 Westpac
 Wing Hang Bank
Elavon Visa, Mastercard, Maestro (UK Domestic),
Diners Club
Elavon Americas Visa, Mastercard, American Express, JCB,
Diners Club, Discover, China UnionPay
When you request a recurring payment
transaction with Visa, Elavon Americas requires
you to comply with the Visa merchant-initiated
transactions mandate by including additional
data in the request. You must do one of the
following:
 Include additional data as described in
"Merchant-Initiated Transactions (MITs) and
Credentials-on-File (COF) Transactions,"
page 173.
 Make the request using the token
management service, which meets the
merchant-initiated transactions requirements.
See Token Management Service Using the
Simple Order API.
FDC Compass Visa, Mastercard, American Express, Discover,
Diners Club, JCB
FDC Germany Visa, Mastercard
FDC Nashville Global Visa, Mastercard, American Express, Discover,
China UnionPay
FDI Australia Visa, Mastercard

Credit Card Services Using the Simple Order API | September 2019 210
 Chapter 5 Optional Features

Table 47 Processors That Support Recurring Payments (Continued)

Processors Payment Card Types

FDMS South Visa, Mastercard, Discover
On FDMS South, recurring payments are not
supported for the CAD currency on the Visa card
type.
FDMS Nashville Visa, Mastercard, American Express, Discover
GPN Visa, Mastercard, American Express, Discover,
Diners Club, JCB
HBoS Visa, Mastercard
HSBC
HSBC is the CyberSource name for HSBC U.K.
To process recurring payments with HSBC, contact the CyberSource European office. For the
European office’s phone number, go to the CyberSource web site and click the Contact Us link:
www.cybersource.com
Ingenico ePayments Visa, Mastercard, American Express, Cartes
Bancaires
Lloyds-OmniPay Visa, Mastercard
LloydsTSB Cardnet Visa, Mastercard
Moneris Visa, Mastercard, American Express, Discover
OmniPay Direct Bank of America Merchant Services: Visa,
Mastercard
Cardnet International: Visa, Mastercard,
Maestro (UK Domestic), Maestro (International)
First Data Merchant Solutions (Europe): Visa,
Mastercard, Discover, Diners Club
Global Payments International Acquiring: Visa,
Mastercard
OmniPay-Ireland Visa, Mastercard
OmniPay-Ireland is the CyberSource name for HSBC International.
To process recurring payments with OmniPay-Ireland, contact the CyberSource European office.
For the European office’s phone number, go to the CyberSource web site and click the Contact
Us link: www.cybersource.com
RBS WorldPay Atlanta Visa, Mastercard, American Express, Discover,
Diners Club, JCB
Rede Visa, Mastercard, American Express, Diners
Club, JCB, Elo, Hipercard
On Rede, recurring payments are not supported
for debit transactions.

Credit Card Services Using the Simple Order API | September 2019 211
 Chapter 5 Optional Features

Table 47 Processors That Support Recurring Payments (Continued)

Processors Payment Card Types

SIX Visa, Mastercard, Discover, Diners Club, JCB,
Maestro (International), Maestro (UK Domestic),
China UnionPay, Visa Electron
Streamline
To process recurring payments with Streamline, contact the CyberSource European office. For
the European office’s phone number, go to the CyberSource web site and click the Contact Us
link: www.cybersource.com
TSYS Acquiring Solutions Visa, Mastercard, American Express, Discover
Worldpay VAP Visa, Mastercard, American Express, Discover,
Diners Club, JCB
Worldpay VAP was previously called Litle.

American Express and Discover have programs that you must register for if you
want to process recurring payments. Contact American Express and Discover
Note for details about their programs.

Depending on the types of products and services you sell, you might want to process
recurring payments for a customer. For example, you might want to charge a customer
19.95 USD each month to access a service that you offer.

A customer’s recurring payment does not have to be the same amount each
time.
Note

You must disclose clearly to customers when they make a purchase what the amount will
be for the recurring payments. If the amount varies based on usage, make it clear.

To create a recurring payment:

Step 1 For the first payment, the type of request you need to send depends on which processor
and card type you are using.

 For all card types on Atos, include the following fields and values in the request for the
first payment:
ccAuthService_commerceIndicator=recurring
ccAuthService_firstRecurringPayment=Y
card_cvNumber

Credit Card Services Using the Simple Order API | September 2019 212
 Chapter 5 Optional Features

 For all card types on Credit Mutuel-CIC, include the following fields and values in the
request for the first payment:
 Set ccAuthService_commerceIndicator to internet, spa, vbv, or vbv_
attempted.
 Set ccAuthService_firstRecurringPayment to Y.

 For Mastercard and American Express transactions on FDC Nashville Global, include
the following fields and values in the request for the first payment:
ccAuthService_commerceIndicator=recurring
ccAuthService_firstRecurringPayment=TRUE
card_cvNumber

 For all card types on OmniPay Direct, request a non-recurring transaction and include
the following field and value in the request for the first payment:
ccAuthService_firstRecurringPayment=Y

 For all other processors and card types, request a non-recurring transaction for a
credit card authorization.

If the first authorization is successful, you can submit subsequent authorizations for
recurring payments using that card. If the first authorization is not successful, do not
submit subsequent authorizations using that card.

You must perform Step 1 once per year to verify the account.

Important

Step 2 For each subsequent recurring payment, send an authorization request using the
e-commerce indicator to indicate that the payment is a recurring payment:
ccAuthService_commerceIndicator=recurring

If your processor supports merchant-initiated transactions, your authorization request

must include subsequent authorization fields as described in "Merchant-Initiated
Transactions (MITs) and Credentials-on-File (COF) Transactions," page 173.

CyberSource also offers services that enable you to create a subscription or customer
profile for a customer in the CyberSource system and then use that subscription or
customer profile later to manually or automatically bill the customer. The CyberSource
system eliminates the need for you to handle or store the customer’s sensitive payment
card information or create your own system for billing the customer on a regular basis. For
more information, see "Payment Tokenization," page 204, and "Recurring Billing,"
page 207.

Credit Card Services Using the Simple Order API | September 2019 213
 Chapter 5 Optional Features

AVS and Recurring Payments

FDMS Nashville does not support AVS for recurring payments.

Note

If AVS is supported for your processor and card type, AVS is run for every authorization
request that you submit. For recurring payments, check the AVS result for the first
payment to ensure that the payment information is accurate and to reduce the risk of
fraud.

You must decide what to do with the AVS results for subsequent payments. You might
want to ignore the AVS results for the these payments because you have already
confirmed with the first payment that the payment card number is valid and not fraudulent.

When you need to change the payment card number used for a series of recurring
payments, follow Step 1 in creating a recurring payment to verify the new account number.
Closely evaluate the AVS results. If the first authorization is successful, you can submit
subsequent authorizations for recurring payments using that card. If the first authorization
is not successful, do not submit subsequent authorizations using that card. For
subsequent payments, follow Step 2 in creating a recurring payment. You can choose to
ignore the AVS results.

CVN and Recurring Payments

FDMS Nashville does not support CVN for recurring payments.

Note

With Ingenico ePayments, you must not include the CVN in a recurring payment request.
If you do, CyberSource rejects the request because of invalid data.

Ingenico ePayments was previously called Global Collect.

Note

Credit Card Services Using the Simple Order API | September 2019 214
 Chapter 5 Optional Features

Replacement Expiration Dates for Recurring

Payments
Service:
 Authorization

Processors and card types:

 See the following table.

Table 48 Processors That Support Replacement Expiration Dates for Recurring Payments

Processors Payment Card Types

AIBMS Visa, Mastercard, Maestro (International)
American Express Brighton American Express
You must contact American Express Brighton to get approval for using
replacement expiration dates before using this feature.
American Express Direct American Express
Barclays Visa, Mastercard, JCB
Chase Paymentech Solutions Visa, Mastercard
CyberSource through VisaNet Visa, Mastercard, American Express, Diners Club, JCB, Discover
Note Not all card types are supported for all acquirers.
If an acquirer is supported for recurring payments, the acquirer is also
supported for replacement expiration dates for recurring payments. For the list
of supported acquirers, see the entry for CyberSource through VisaNet in
Table 47, "Processors That Support Recurring Payments," on page 207.
Elavon Americas Visa, Mastercard, American Express, JCB, Diners Club, Discover,
China UnionPay
FDC Compass Visa, Mastercard, American Express, Discover, Diners Club
FDC Germany Visa, Mastercard
FDI Australia Visa, Mastercard
FDMS South Visa, Mastercard
HBoS Visa, Mastercard
HSBC Visa, Mastercard, Maestro (International)
HSBC is the CyberSource
name for HSBC U.K.
Lloyds-OmniPay Visa, Mastercard
LloydsTSB Cardnet Visa, Mastercard
Streamline To process recurring payments with Streamline, contact the CyberSource
European office. For the European office’s phone number, go to the
CyberSource web site and click the Contact Us link: www.cybersource.com

Credit Card Services Using the Simple Order API | September 2019 215
 Chapter 5 Optional Features

Normally when you request a credit card authorization, you must provide a valid expiration
date for the payment card. If you are processing a recurring payment, and the payment
card that you have on file for the customer has expired, you might still be able to request
the authorization depending on which processor you use. Instead of sending the out-of-
date expiration date, you can include a replacement expiration date in your request.

Do not use a replacement expiration date for cards that have not expired. Use
a replacement expiration date only for cards that have expired and only for
Important recurring payments.
Using a replacement expiration date for a recurring payment does not
guarantee that the authorization will be successful. The issuing bank
determines whether a card is authorized; some issuing banks do not accept
an expiration date that does not match the expiration date in the bank’s
database.

Effective October 17, 2014, an issuing bank can decline an authorization

request for a recurring transaction with a Visa Europe card if the expiration date
Important is incorrect, invalid, or missing. If you do not provide the correct expiration date
for a recurring transaction, the authorization request might be declined.

The replacement expiration date that CyberSource supports is 12/2099. To use this date,
include these fields and values in your authorization request:
card_expirationMonth=12
card_expirationYear=2099

Recurring Profiles
See "Recurring Billing," page 207.

Credit Card Services Using the Simple Order API | September 2019 216
 Chapter 5 Optional Features

Report Groups
Services:
 Authorization
 Full authorization reversal
 Capture
 Credit

Processor:
 Worldpay VAP—Worldpay VAP was previously called Litle.

Report group values enable you to define custom groups for your processor reports. You
can put your transactions into groups and then request processor reports for each group.
This value is case sensitive and space sensitive.

When you do not have a specific report group structure in mind, Worldpay VAP
recommends that you use your merchant ID as your report group value.
Note

To use multiple report groups for your transactions, you must contact Worldpay
VAP to have your Worldpay VAP account configured for this feature. When
Important using one report group for all your transactions, you do not need to have your
Worldpay VAP account configured for this feature.

Credit Card Services Using the Simple Order API | September 2019 217
 Chapter 5 Optional Features

The following table describes the logic that CyberSource uses for each kind of request to
determine which report group value to use.

Table 49 Determining Which Report Group Value to Use

Kind of Request Report Group Value

Authorization or CyberSource checks the following locations, in the order given, for a report
Stand-Alone Credit group value and uses the first value it finds:
 reportGroup field in the authorization or stand-alone credit request
 Report group value in your CyberSource account: Your CyberSource
account can have a different report group value for each currency that
you process. CyberSource uses the report group value that
corresponds to the currency for the transaction. To create a default
report group value in your CyberSource account, contact CyberSource
Customer Support.
 Your Worldpay VAP merchant ID
Capture or CyberSource checks the following locations, in the order given, for a report
Full Authorization group value and uses the first value it finds:
Reversal
 reportGroup field in the capture or full authorization reversal request
 Report group value that was used for the authorization request
Follow-on Credit CyberSource checks the following locations, in the order given, for a report
group value and uses the first value it finds:
 reportGroup field in the follow-on credit request
 Report group value that was used for the capture that is being credited
 Report group value that was used for the authorization request

Retail POS Data

See Card-Present Processing Using the Simple Order API.

Samsung Pay
See Samsung Pay Using the Simple Order API.

Secure Data
See "Payment Tokenization," page 204.

Credit Card Services Using the Simple Order API | September 2019 218
 Chapter 5 Optional Features

Service Fees
See Service Fee Processing Using the Simple Order API.

Single-Message Processing
See "Single-Message Processing," page 76.

Soft Descriptors
See "Merchant Descriptors," page 169.

Split Dial/Route
See "Forced Captures," page 142.

Credit Card Services Using the Simple Order API | September 2019 219
 Chapter 5 Optional Features

Split Shipments
Services:
 Authorization
 Capture

Processors:
 CyberSource through VisaNet

Split shipments are not available for Mastercard transactions in the IDR
currency on CyberSource through VisaNet.
Important

 GPN

The split-shipment feature enables you to split an order into multiple shipments with
multiple captures.

Multiple partial captures and split shipments are not the same feature.
 The multiple partial captures feature is provided by the processor. This
Note feature enables you to request multiple partial captures for one
authorization. For more information, see "Multiple Partial Captures,"
page 71.

 The split-shipment feature is provided by CyberSource. This feature

supports three different scenarios: multiple authorizations, multiple
captures, and multiple authorizations with multiple captures.

Benefits of Using Split Shipments

The benefits of using split shipments are:

 All the transactions for a split shipment are linked together in the Business Center and
in reports.

 When you split an order into multiple shipments with multiple captures, you do not
need to request additional authorizations; CyberSource takes care of the additional
authorizations for you.

Credit Card Services Using the Simple Order API | September 2019 220
 Chapter 5 Optional Features

Requirements
The requirements for using split shipments are:
 You must use CyberSource through VisaNet or GPN.
 You must contact CyberSource Customer Support to have your account configured for
this feature. On CyberSource through VisaNet, your account can be enabled for
multiple partial captures or split shipments; it cannot be enabled for both features.

How Split Shipments Work

Additional Authorizations
When you need an additional authorization for an order, you can use the link-to-request
field to link the additional authorization to the first authorization. For the additional
authorization, you must submit an authorization request that includes the link-to-request
field in addition to the basic fields required for every authorization request. The additional
authorization is linked to the original authorization in the Business Center and in reports.
The captures for these authorizations are also linked to the original authorization in the
Business Center and in reports.

For an additional authorization on a processor that supports merchant-initiated

transactions, your authorization request must include subsequent authorization fields as
described in "Merchant-Initiated Transactions (MITs) and Credentials-on-File (COF)
Transactions," page 173.

For scenarios that use an additional authorization, see the following sections:
 "One Authorization and One Sale," page 222
 "Two Authorizations and One Capture," page 224

For examples that use an additional authorization, see:

 Name-value pair examples: "Split-Shipment Examples," page 417
 XML examples: "Split-Shipment Examples," page 447

Additional Captures
When you need an additional capture for an order, CyberSource performs a system-
generated authorization for the additional capture request, using the payment data from
the original authorization. The system-generated authorization is linked to the original
authorization in the Business Center and in reports. The captures are linked to the
authorizations in the Business Center and in reports through the request IDs as with any
capture.

On GPN, the system-generated authorization uses the same authorization indicator as the
original authorization. For more information, see "Final Authorization Indicator," page 138.

Credit Card Services Using the Simple Order API | September 2019 221
 Chapter 5 Optional Features

For scenarios that use an additional capture, see the following sections:
 "One Authorization and Two Captures," page 223
 "Multiple Captures in a Batch File," page 223

For examples that use an additional capture, see:

 Name-value pair examples: "Split-Shipment Examples," page 417
 XML examples: "Split-Shipment Examples," page 447

Split-Shipment Scenarios

One Authorization and One Sale

In this scenario, your customer orders a product that is not available yet.

1 You request an authorization to ensure that funds are available.

The product is not available for immediate shipment, so you wait for the product to
become available.

2 After the product becomes available, you ship the product and request a sale.
For the second authorization, you must submit an authorization request that includes the
link-to-request field in addition to the basic fields required for every authorization request.
Set the link-to-request field to the request ID from the first authorization’s reply:
First Authorization Reply Message: requestID=SWVdPS5IM
Second Authorization Request: linkToRequest=SWVdPS5IM

Including the link-to-request field in your authorization request triggers the split-shipment
functionality. Because you are requesting the second authorization and capture together,
you do not need to include the request ID in your capture request.

3 CyberSource tries to link the second authorization request to the first authorization:

 If the link-to-request value is valid, the second authorization is linked to the original
authorization in the Business Center and in reports.

 If the link-to-request value is not valid, the second authorization is not linked to the
original authorization in the Business Center and in reports.

4 CyberSource links the capture request:

 If the link-to-request value for the second authorization was valid, all three
transactions (first authorization, second authorization, capture) are linked together in
the Business Center and in reports.

 If the link-to-request value for the second authorization was not valid, the second
authorization and capture are linked to each other in the Business Center and in
reports, but they are not linked to the first authorization.

Credit Card Services Using the Simple Order API | September 2019 222
 Chapter 5 Optional Features

One Authorization and Two Captures

In this scenario, your customer orders multiple products, one of which is not available yet.

1 You request an authorization to ensure that funds are available.

2 You ship the available products and request a capture for the amount of the shipped
products.
One of the products is not available for immediate shipment, so you ship the available
products and wait for the remaining product to become available.

3 After the remaining product becomes available, you ship the product and request a
capture for the amount of that product.

4 CyberSource performs a system-generated authorization for the second capture request.

Because your account is enabled for split shipment, instead of rejecting the capture
request as a duplicate capture, CyberSource processes the capture request as a split-
shipment request.
The system-generated authorization is linked to the original authorization in the Business
Center and in reports.

5 CyberSource links the capture request.

The capture is linked to the authorizations in the Business Center and in reports through
the request IDs as with any capture. All four transactions (first authorization, system-
generated authorization, first capture, second capture) are linked together in the Business
Center and in reports.

6 You get the status of the second capture request and its associated system-generated
authorization.
See "Obtaining the Status of a System-Generated Authorization," page 225.

Multiple Captures in a Batch File

You can also request authorizations in a batch file.

Note

1 You create and upload a batch file using one of these methods:

 Business Center Transaction Batch Functionality: This functionality is described in the

Offline Transaction File Submission Implementation Guide and in the Online Help for
the Business Center.

 Offline Transaction File Submission System: This system is described in the Offline
Transaction File Submission Implementation Guide.

Credit Card Services Using the Simple Order API | September 2019 223
 Chapter 5 Optional Features

2 CyberSource processes the batch file.

3 You get the status of your batch requests by viewing the Batch Submission Detail Report.
Get the report by using one of these methods, both of which are described in the Offline
Transaction File Submission Implementation Guide:
 View the report on the Business Center.
 Download the report programmatically.

4 You get the status of your split-shipment transactions.

Two Authorizations and One Capture

In this scenario, your customer orders a product that is not available yet.

1 You request an authorization to ensure that funds are available.

The product is not available for immediate shipment, so you wait for the product to
become available.

2 After the product becomes available, you request a second authorization to ensure that
funds are still available. The authorization request must include:
 Basic fields required for every authorization request.

 Link-to-request field. Set the value for this field to the request ID from the first
authorization’s reply:
First Authorization Reply Message: requestID=SWVdPS5IM
Second Authorization Request: linkToRequest=SWVdPS5IM
Including the link-to-request field in your authorization request triggers the split-
shipment functionality.

 On a processor that supports merchant-initiated transactions: subsequent

authorization fields as described in "Merchant-Initiated Transactions (MITs) and
Credentials-on-File (COF) Transactions," page 173.

3 CyberSource tries to link the second authorization request to the first authorization:

 If the link-to-request value is valid, the second authorization is linked to the original
authorization in the Business Center and in reports.

 If the link-to-request value is not valid, the second authorization is not linked to the
original authorization in the Business Center and in reports.

4 You ship the product and request a capture.

Set the request ID in the capture request to the request ID from the second authorization’s
reply:
Second Authorization Reply Message: requestID=sl39cmdSlkJ
Capture Request: ccCaptureService_authRequestID=sl39cmdSlkJ

Credit Card Services Using the Simple Order API | September 2019 224
 Chapter 5 Optional Features

5 CyberSource links the capture request:

 If the link-to-request value for the second authorization was valid, all three
transactions (first authorization, second authorization, capture) are linked together in
the Business Center and in reports.

 If the link-to-request value for the second authorization was not valid, the second
authorization and capture are linked to each other in the Business Center and in
reports, but they are not linked to the first authorization.

Obtaining the Status of a System-Generated

Authorization
A system-generated authorization is not performed in real time. The reply message that
you receive from CyberSource simply indicates that the request was received; it does not
indicate whether the system-generated authorization was approved or declined. A
system-generated authorization can be declined for the same reasons that a regular
authorization can be declined.

CyberSource recommends that you use one of the methods described in the following
table to get the status of the system-generated authorization request before shipping the
product.

Table 50 Methods for Obtaining the Status of a System-Generated Authorization

Method Description
Business Center Use the capture request ID to search for the second capture. The
details for all related transactions are displayed on the Transaction
Search Details page. It can take a maximum of six hours for the
status of the system-generated authorization request to be
available.
On-Demand Single This report is described in the Classic Reporting Developer Guide.
Transaction Report You must use version 1.3 or later and include the parameter
includeExtendedDetail in your query. It can take a maximum of six
hours for the status of the system-generated authorization request
to be available.
Transaction Exception This report is described in the Classic Reporting Developer Guide.
Detail Report CyberSource recommends that you use this report on a daily basis
to identify transactions that have been declined.

Credit Card Services Using the Simple Order API | September 2019 225
 Chapter 5 Optional Features

Additional Information
For descriptions of the required fields for authorization and capture requests, and to see
which fields are optional, see Appendix A, "API Fields," on page 240.

For examples of split-shipment requests and replies, see:

 Name-value pair examples: "Split-Shipment Examples," page 417
 XML examples: "Split-Shipment Examples," page 447

Staged Digital Wallets

Services:
 Authorization
 Capture

Processor:
 FDC Compass

Terminology
Table 51 Staged Digital Wallet Terminology

Term Definition
Business application Identifier for the type of transaction.
indicator (BAI)
Digital wallet Entity that provides the pass-through digital wallet or staged digital
operator (DWO) wallet service to the customer.
Merchant verification Setting in your CyberSource account that is required for processing
value (MVV) SDW transactions.
Pass-through wallet Digital wallet that replaces the customer’s payment information with a
or pass-through token. Examples: Apple Pay, Google Pay, Visa Checkout, Masterpass.
digital wallet
Staged digital wallet Digital wallet that replaces the customer’s payment information with
(SDW) credentials provided by a SDWO. Examples: PayPal, AliPay.
Staged digital wallet Entity that provides the staged digital wallet service to the customer and
operator (SDWO) processes the payment between the customer and the merchant.

Credit Card Services Using the Simple Order API | September 2019 226
 Chapter 5 Optional Features

Requirements
You must:

 Contact CyberSource Customer Support to set the merchant verification value in your
CyberSource account.

 Include the invoiceHeader_businessApplicationID field in the authorization request

and set it to WT.

SDW Functionality
The SDW provides functionality that:

 Uses the card or bank account number supplied by the customer to the SDWO.

 Uses a separate account or accounts assigned by the SDWO to the customer.

 Completes a transaction through the SDWO in two stages, in any order:

 Purchase transaction: customer pays you using the credentials assigned by the
SDWO. For example, the typical credentials for PayPal are a username and a
password.

 Funding: uses the account number provided by the customer to fund or reimburse
the staged digital wallet.

Subscriptions
See "Recurring Billing," page 207.

Tax Calculation
See Tax Calculation Service Using the Simple Order API.

Tokenization
See "Payment Network Tokenization," page 204, and "Token Management Service
(TMS)," page 228.

Credit Card Services Using the Simple Order API | September 2019 227
 Chapter 5 Optional Features

Token Management Service (TMS)

Token Management Service replaces Payment Tokenization. TMS enables you to:
 Tokenize customers’ sensitive personal information.
 Eliminate payment data from your order management system to ensure that it is not
compromised during a security breach.

When you use TMS, you can process an authorization, capture, or credit by using
information that is associated with a customer token. CyberSource uses the customer
token to reference customer information in the CyberSource database. Instead of
providing all the information that is normally required for a transaction, you only need to
provide the following values:
 Merchant ID
 Merchant reference code
 Amount of the payment or credit
 Subscription ID—set this field to the value of the customer token.

You can override most of the information associated with the customer token by including
the relevant API fields in the payment or credit request. For example, you could provide a
different billing or shipping address in the request. You cannot override the payment card
account number.

See Token Management Service Using the Simple Order API.

Type II Cards
See Level II and Level III Processing Using the Simple Order API.

Verbal Authorizations
See "Verbal Authorizations," page 101.

Credit Card Services Using the Simple Order API | September 2019 228
 Chapter 5 Optional Features

Visa Bill Payments

Services:
 Authorization
 Credit

Processors:
 Chase Paymentech Solutions
 FDC Compass
 FDC Nashville Global
 FDMS Nashville
 GPN
 OmniPay-Ireland: OmniPay-Ireland is the CyberSource name for HSBC International.
 TSYS Acquiring Solutions

Visa provides a Bill Payment program that enables customers to use their Visa cards to
pay their bills. When you participate in this program, Visa requests that you flag the bill
payments and credits so they can be easily identified. To flag these transactions, include
the ccAuthService_billPayment field in your transaction requests.

Although CyberSource accepts the bill payment indicator no matter which processor you
are using, do not use this indicator if you have not signed up with Visa to participate in the
program.

Visa Checkout and Visa Secure Remote

Commerce
See:
 Visa Checkout and Visa Secure Remote Commerce web page
 "Creating an Authorization Request," page 41
 "Visa Checkout and Visa Secure Remote Commerce Examples," page 424 (NVP)
 "Visa Checkout and Visa Secure Remote Commerce Examples," page 458 (XML)

Credit Card Services Using the Simple Order API | September 2019 229
 Chapter 5 Optional Features

Visa Debt Repayments

Services:
 Authorization
 Credit
Processors:
 CyberSource through VisaNet—supported only in Australia and New Zealand
 FDC Nashville Global
 FDMS Nashville
 GPN

Visa provides a Debt Repayment program that enables customers to use their Visa debit
cards to make a payment towards an existing contractual loan. The types of loans that can
qualify for this program are:
 Auto loans
 Payment cards
 Mortgages
 Student loans

To participate in this program, contact your processor for details and requirements.

When you participate in this program, Visa requests that you flag the debt repayments and
credits so they can be easily identified. To flag these transactions, include these fields in
your transaction requests:
 ccAuthService_billPayment—not required on CyberSource through VisaNet
 debtIndicator

When you use the Simple Order API in XML format, you must use version 1.37
or later of the XML schema to implement Visa debt repayments.
Note

Visa Direct
Visa Direct is one of the networks supported by CyberSource Payouts.See Payouts Using
the Simple Order API.

Visa Secure
See "Payer Authentication," page 186.

Credit Card Services Using the Simple Order API | September 2019 230
 Chapter 5 Optional Features

Zero Amount Authorizations

Service:
 Authorization

Processors and card types:

 See the following table.

Table 52 Processors That Support Zero Amount Authorizations

Processor AVS CVN Card Types and Notes

AIBMS Yes Yes  Visa
 Mastercard
For zero amount authorizations on AIBMS, the
commerce indicator must be internet or
moto.
American Express Direct Yes No  American Express
All currencies that are supported for standard
authorizations for American Express Direct
are also supported for zero amount
authorizations.
Barclays Yes Yes  Visa
 Mastercard
All currencies that are supported for standard
authorizations for Barclays are also supported
for zero amount authorizations.
CyberSource rounds the amount to the correct
number of decimal places for the currency.
For zero amount authorizations on Barclays,
the commerce indicator must be internet
or moto.
Visa Electron cards are not supported for zero
amount authorizations on Barclays.
Chase Paymentech Solutions Yes Yes  Visa
 Mastercard
 American Express
 Discover
 Diners Club
Credit Mutuel-CIC No Yes  Visa
 Mastercard
 Cartes Bancaires

Credit Card Services Using the Simple Order API | September 2019 231
 Chapter 5 Optional Features

Table 52 Processors That Support Zero Amount Authorizations (Continued)

Processor AVS CVN Card Types and Notes

CyberSource through VisaNet Yes Yes  Visa
 Mastercard
For CyberSource through VisaNet, zero
amount authorizations are supported for
Internet, MOTO, and card-present
transactions. Do not try to perform a zero
amount authorization for a recurring,
installment, or payer authorization transaction.
Elavon Yes Yes  Visa
 Mastercard
 Maestro (UK Domestic)
 Maestro (International)
All currencies that are supported for standard
authorizations for Elavon are also supported
for zero amount authorizations.
Elavon Americas Yes Yes  Visa
 Mastercard
 American Express
 JCB
 Diners Club
 Discover
 China UnionPay
FDC Compass Yes Yes  Visa
 Mastercard
 American Express
 Diners Club

Credit Card Services Using the Simple Order API | September 2019 232
 Chapter 5 Optional Features

Table 52 Processors That Support Zero Amount Authorizations (Continued)

Processor AVS CVN Card Types and Notes

FDC Nashville Global Yes Yes for all card  Visa
types except
 Mastercard
American
Express  American Express
 Discover
 Diners Club
For a zero amount authorization on FDC
Nashville Global:
 For Visa, Mastercard, and American
Express, all currencies that are supported
for standard authorizations are also
supported for zero amount authorizations.
 For Discover and Diners Club, only USD is
supported for zero amount authorizations.
FDI Australia Yes Yes  Visa—supported only for AUD.
 Mastercard—supported only for AUD.
FDMS Nashville Yes Yes  Visa
FDMS South Yes Yes for all card  Visa
types except
 Mastercard
American
Express  American Express:
 AVS is required for zero amount
authorizations with American Express.
 CVN is not supported for zero amount
authorizations with American Express.
 Diners Club
 Discover
Getnet No No  Visa
 Mastercard
 Hipercard
GPN Yes Yes for all card  Visa
types except
 Mastercard
American
Express  American Express: CVN is not supported
for zero amount authorizations with
American Express.
 Discover
 JCB

Credit Card Services Using the Simple Order API | September 2019 233
 Chapter 5 Optional Features

Table 52 Processors That Support Zero Amount Authorizations (Continued)

Processor AVS CVN Card Types and Notes

HBoS Yes Yes  Visa
 Mastercard
For zero amount authorizations on HBoS, the
commerce indicator must be internet or
moto.
HSBC Yes Yes  Visa
HSBC is the CyberSource  Mastercard
name for HSBC U.K.
 Maestro (UK Domestic)
 Maestro (International)
For zero amount authorizations on HSBC:
 The commerce indicator must be
internet or moto.
 The authorization code is not returned.
JCN Gateway No Yes  Visa
 Mastercard
 American Express
 Diners Club
 JCB
Lloyds-OmniPay Yes Yes  Visa
 Mastercard
For zero amount authorizations on Lloyds-
OmniPay, the commerce indicator must be
internet or moto.
LloydsTSB Cardnet Yes Yes  Visa
 Mastercard
For zero amount authorizations on LloydsTSB
Cardnet, the commerce indicator must be
internet or moto.
Moneris Yes Yes  Visa
 Mastercard

Credit Card Services Using the Simple Order API | September 2019 234
 Chapter 5 Optional Features

Table 52 Processors That Support Zero Amount Authorizations (Continued)

Processor AVS CVN Card Types and Notes

OmniPay Direct Yes Yes Bank of America Merchant Services: Visa,
Mastercard, Maestro (UK Domestic),
Maestro (International)
Cardnet International: Visa, Mastercard,
Maestro (UK Domestic),
Maestro (International)
First Data Merchant Solutions (Europe): Visa,
Mastercard, Discover, Diners Club,
Maestro (UK Domestic),
Maestro (International)
Global Payments International Acquiring:
Visa, Mastercard, Maestro (UK Domestic),
Maestro (International)
OmniPay-Ireland Yes Yes  Visa
OmniPay-Ireland is the  Mastercard
CyberSource name for HSBC
International.
RBS WorldPay Atlanta Yes Yes  Visa
 Mastercard
 Diners Club
Rede No No  Visa
 Mastercard
SIX Yes Yes  Visa
 Mastercard
 Discover
 Diners Club
 JCB
 Maestro (International)
 Maestro (UK Domestic)
 China UnionPay
 Visa Electron

Credit Card Services Using the Simple Order API | September 2019 235
 Chapter 5 Optional Features

Table 52 Processors That Support Zero Amount Authorizations (Continued)

Processor AVS CVN Card Types and Notes

Streamline Yes Yes  Visa
 Mastercard
 Maestro (International)
 Maestro (UK Domestic)
 Cartes Bancaires
 Dankort
All currencies that are supported for standard
authorizations for Streamline are also
supported for zero amount authorizations.
For a zero amount authorization:
 The commerce indicator must be
internet or moto.
 Payer authentication is not supported.
TSYS Acquiring Solutions Yes Yes for Visa and  Visa
Mastercard. No
 Mastercard
for American
Express and  American Express: CVN is not supported
Discover. for zero amount authorizations with
American Express.
 Discover: CVN is not supported for zero
amount authorizations with Discover.
Worldpay VAP Yes Yes  Visa
Worldpay VAP was previously  Mastercard
called Litle.
 American Express
 Discover
 Diners Club
 JCB

Authorizing a payment for a zero amount shows whether a payment card account is valid
and whether the card is lost or stolen. You cannot capture a zero amount authorization.

Credit Card Services Using the Simple Order API | September 2019 236
 CHAPTER
Testing the Credit Card
Services
6

To ensure that your requests are processed correctly, you must test the basic success and
error conditions for each CyberSource service you plan to use.

Requirements for Testing

Before you can test, you must contact CyberSource Customer Support to
activate the credit card services and configure your account for testing. You
Important must also contact your processor to set up your processor account.

 Use your regular CyberSource merchant ID when you test your system.

 Unless otherwise specified, use test payment card numbers, not real ones. See
Table 53, "Test Payment Card Numbers," on page 238.

 Use a real combination for the city, state, and postal code.

 Use a real combination for the area code and telephone number.

 Use a nonexistent account and domain name for the customer’s email address.

 When testing an Ingenico ePayments country-specific payment card, such as Italy’s

Carta Si, specify the appropriate country code when sending the customer’s address
and specify the currency used in that country.

Ingenico ePayments was previously called Global Collect.

Note

 When testing the Simple Order API, use the test URL:
https://ics2wstesta.ic3.com/commerce/1.x/transactionProcessor

Credit Card Services Using the Simple Order API | September 2019 237
 Chapter 6 Testing the Credit Card Services

When you test captures on Ingenico ePayments, you must capture the full
amount of the authorization. Although a capture request for a partial amount is
Note not rejected during testing, it will be rejected by the processor in production.
Ingenico ePayments was previously called Global Collect.

Testing the Services

Use the payment card numbers in the following table to test the authorization, capture,
and credit services. Do not use real payment card numbers. To test card types not listed in
the table, use an account number that is within the card’s bin range. For best results, try
each test with a different CyberSource service request and with different test payment
card numbers.

Table 53 Test Payment Card Numbers

Payment Card Type Test Account Number

(Remove spaces when sending to CyberSource.)
American Express 3782 8224 6310 005
Discover 6011 1111 1111 1117
JCB 3566 1111 1111 1113
Maestro (International) 5033 9619 8909 17
5868 2416 0825 5333 38
Maestro (UK Domestic) 6759 4111 0000 0008
6759 5600 4500 5727 054
5641 8211 1116 6669
Note Effective May 2011, the issue number is no longer
required for Maestro (UK Domestic) transactions.
Mastercard 2222 4200 0000 1113
2222 6300 0000 1125
5555 5555 5555 4444
UATP 1354 1234 5678 911
Visa 4111 1111 1111 1111

Credit Card Services Using the Simple Order API | September 2019 238
 Chapter 6 Testing the Credit Card Services

Using Amounts to Simulate Errors

You can simulate the CyberSource error messages by requesting authorization, capture,
or credit services with specific amounts that trigger the error messages. These triggers
work only on the test server, not on the production server. Each payment processor uses
its own error messages.

For trigger amounts and responses, see Simple Order API and SOAP Toolkit API Testing
Information page.

Testing American Express Card Verification

Before using CVN with American Express, CyberSource strongly recommends that you
perform this procedure.

To test American Express card verification:

Step 1 Contact CyberSource Customer Support to have your account configured for CVN. Until
you do this, you will receive a 1 in the ccAuthReply_cvCode reply field.

Step 2 Test your system in production using a small currency amount, such as one currency unit.
Instead of using the test account numbers, use a real payment card account number, and
send an incorrect CVN in the request for authorization. The card should be refused and
the request declined.

Credit Card Services Using the Simple Order API | September 2019 239
 APPENDIX
API Fields
A

Formatting Restrictions
Unless otherwise noted, all field names are case sensitive and all fields accept special
characters such as @, #, and %.

The values of the item_#_ fields must not contain carets (^) or colons (:)
because these characters are reserved for use by the CyberSource services.
Note Values for request-level and item-level fields must not contain new lines or
carriage returns. However, they can contain embedded spaces and any other
printable characters. CyberSource removes all leading and trailing spaces.

Atos
The billTo_ fields must not contain colons (:).

Moneris
Values for request-level and item-level fields must not contain these special
characters: ampersands (&), single quotes (‘), double quotes (“), less than
signs (<), and greater than signs (>).

Multibyte Characters
Many international languages – such as Korean, Chinese, and Russian – require more than one
ASCII byte per character. Therefore, a string of multibyte characters can exceed the allotted string
length of some API fields.
In many international languages, a short name that visually has only 3 or 4 characters may be
equivalent to 10 or 15 bytes in UTF-8. Therefore, it is important to take into consideration the overall
length of a multibyte string to be sure it fits into the allotted ASCII string length.

For best success when working with international languages, make sure the
total size of a multibyte string does not exceed the ASCII string length for a
Important specific API field.

Credit Card Services Using the Simple Order API | September 2019 240
 Appendix A API Fields

Data Type Definitions

For more information about these data types, see the World Wide Web Consortium (W3C)
XML Schema Part 2: Datatypes Second Edition.
Table 54 Data Type Definitions

Data Type Description

Date and time Format is YYYY-MM-DDThh:mm:ssZ, where:
 T separates the date and the time
 Z indicates Coordinated Universal Time (UTC), also known as Greenwich
Mean Time (GMT)
Example 2019-08-11T22:47:57Z equals August 11, 2019, at 22:47:57
(10:47:57 p.m.).
Integer Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}
String Sequence of letters, numbers, spaces, and special characters

Credit Card Services Using the Simple Order API | September 2019 241
 Appendix A API Fields

Numbered Elements
The CyberSource XML schema includes several numbered elements. You can include
these complex elements more than once in a request. For example, when a customer
order includes more than one item, you must include multiple <item> elements in your
request. Each item is numbered, starting with 0. The XML schema uses an id attribute in
the item’s opening tag to indicate the number. For example:
<item id="0">

As a name-value pair field name, this tag is represented as item_0. In this portion of the
field name, the underscore before the number does not indicate hierarchy in the XML
schema. The item fields are generically referred to as item_#_<element name> in the
documentation.

Below is an example of the numbered <item> element and the corresponding name-
value pair field names. If you are using the Simple Object Access Protocol (SOAP), the
client contains a corresponding Item class.
Example 3 Numbered XML Schema Element Names and
Name-Value Pair Field Names

XML Schema Corresponding Name-Value

Element Names Pair Field Names
<item id="0">
<unitPrice> item_0_unitPrice
<quantity> item_0_quantity
</item>
<item id="1">
<unitPrice> item_1_unitPrice
<quantity> item_1_quantity
</item>

When a request is in XML format and includes an <item> element, the

element must include an id attribute. For example: <item id="0">.
Important

Credit Card Services Using the Simple Order API | September 2019 242
 Appendix A API Fields

Request Fields

When you use Payment Tokenization or Recurring Billing and you include a
subscription ID in your request, many of the fields in the following table that are
Note normally required for an authorization or credit become optional. See "Payment
Tokenization," page 204, and "Recurring Billing," page 207.

Table 55 Request Fields

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
authIndicator Flag that specifies the purpose of the Authorization (O for String (1)
authorization. Possible values: Mastercard and Maestro
transactions; not used
 0: Preauthorization
for other card types)
 1: Final authorization
Incremental
To set the default for this field, contact Authorization (O for
CyberSource Customer Support. Mastercard; not used for
See "Final Authorization Indicator," page 138. other card types)

Barclays and Elavon

The default for Barclays and Elavon is 1 (final
authorization). To change the default for this
field, contact CyberSource Customer Support.
CyberSource through VisaNet
When the value for this field is 0, it corresponds
to the following data in the TC 33 capture file5:
 Record: CP01 TCR0
 Position: 164
 Field: Additional Authorization Indicators
When the value for this field is 1, it does not
correspond to any data in the TC 33 capture
file.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 243
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
balanceInquiry Flag indicating whether to return balance Authorization (R for a String (5)
information. See "Balance Inquiries," page 128. balance inquiry;
otherwise, not used.)
Possible values:
 true
 false
billPaymentType Reason for the payment. Possible values: Authorization (R for bill String (3)
payments with
 001: Utility payment
Mastercard in Brazil on
 002: Government services CyberSource through
 003: Mobile phone top-up VisaNet)

 004: Coupon payment

The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 48-50
 Field: Bill Payment Transaction Type
Identifier
This field is supported only for bill payments in
Brazil with Mastercard on CyberSource through
VisaNet. See "Mastercard Bill Payments,"
page 167.
Note For information about bill payments with
Visa, see "Visa Bill Payments," page 229.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 244
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_buildingNumber Building number in the street address. For Authorization (O for String (256)
example, if the street address is: Cielo. R for Redecard
customer validation with
Rua da Quitanda 187
CyberSource Latin
then the building number is 187. This field is American Processing.
supported only for: Otherwise, not used.)
 Transactions on Cielo.
 Redecard customer validation on
CyberSource Latin American Processing.
billTo_city City of the billing address. Authorization (R)2 Atos:
String (32)
Atos Capture (O)
This field must not contain colons (:). All other
Credit (R)1,2
processors:
CyberSource through VisaNet
String (50)
Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 245
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_company Name of the customer’s company. Authorization (O) String (60)
CyberSource through VisaNet Capture (O)
Credit card networks cannot process
Credit (O)
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 246
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_companyTaxID Tax identifier for the customer’s company. This Authorization (See String (9)
field is supported only for these kinds of description)
payments:
Capture (See
 BNDES transactions on CyberSource description)
through VisaNet. See "BNDES," page 129.
Credit (See the field
 Installment payments with Mastercard on description; BNDES
CyberSource through VisaNet in Brazil. See transactions only.)
"Installment Payments on CyberSource
through VisaNet," page 150.
Set this field to the Cadastro Nacional da
Pessoa Jurídica (CNPJ). The request must
include this field or billTo_personalID. When a
request includes both fields, CyberSource
sends the value for the billTo_personalID field
to the processor and ignores the billTo_
companyTaxID field.
For BNDES transactions, the value for this field
corresponds to the following data in the TC 33
capture file5:
 Record: CP07 TCR6
 Position: 26-39
 Field: Buyer ID
For installment payments with Mastercard in
Brazil, the value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR4
 Position: 26-39
 Field: Buyer ID
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 247
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_country Country of the billing address. Use the two- Authorization (R)2 String (2)
character ISO Standard Country Codes.
Capture (O)
CyberSource through VisaNet
Credit (R)1,2
Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 248
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_customerID Your identifier for the customer. When a Authorization (R for Comercio
subscription or customer profile is being recurring transactions in Latino: String
created, the maximum length for this field for Mexico on Comercio (20)
most processors is 30. Otherwise, the Latino; otherwise, O.)
All other
maximum length is 100.
Capture (O) processors:
Comercio Latino String (100)
Credit (O)
For recurring payments in Mexico, the value is
the customer’s contract number.
Note Before you request the authorization,
you must inform the issuer of the customer
contract numbers that will be used for recurring
transactions.
Worldpay VAP
For a follow-on credit with Worldpay VAP,
CyberSource checks the following locations, in
the order given, for a customer account ID
value and uses the first value it finds:
1 billTo_customerID value in the follow-on
credit request
2 Customer account ID value that was used for
the capture that is being credited
3 Customer account ID value that was used for
the original authorization
If a customer account ID value cannot be found
in any of these locations, then no value is used.
billTo_district Customer’s neighborhood, community, or Authorization (O) String (50)
region (a barrio in Brazil) within the city or
municipality. This field is available only on
Cielo.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 249
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_email Customer’s email address, including the full Authorization (R)2 String (255)
domain name.
Capture (O)
CyberSource through VisaNet
Credit (R)1,2
Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 250
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_firstName Customer’s first name. This name must be the Authorization (R)2 CyberSource
same as the name on the card. Latin
Capture (O)
American
CyberSource Latin American Processing
Credit (R)1,2 Processing:
Important For an authorization request, see field
CyberSource Latin American Processing description
concatenates billTo_firstName and billTo_
Worldpay
lastName. If the concatenated value exceeds
VAP:
30 characters, CyberSource Latin American
String (25)
Processing declines the authorization request.
All other
Note CyberSource Latin American Processing processors:
is the name of a specific processing connection String (60)
that CyberSource supports. In the CyberSource
API documentation, CyberSource Latin
American Processing does not refer to the
general topic of processing in Latin
America.The information in this field description
is for the specific processing connection called
CyberSource Latin American Processing. It is
not for any other Latin American processors
that CyberSource supports.

CyberSource through VisaNet

Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 251
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_hostname DNS resolved hostname from billTo_ Authorization (O) String (60)
ipAddress.
Capture (O)
Credit (O)
billTo_httpBrowserType Customer’s browser as identified from the Authorization (O) String (40)
HTTP header data. For example, Mozilla is
Capture (O)
the value that identifies the Netscape browser.
Credit (O)
billTo_ipAddress Customer’s IP address. Authorization (O) String (15)
Capture (O)
Credit (O)
billTo_lastName Customer’s last name. This name must be the Authorization (R)2 CyberSource
same as the name on the card. Latin
Capture (O)
American
CyberSource Latin American Processing
Credit (R)1,2 Processing:
Important For an authorization request, see field
CyberSource Latin American Processing description
concatenates billTo_firstName and billTo_
Worldpay
lastName. If the concatenated value exceeds
VAP:
30 characters, CyberSource Latin American
String (25)
Processing declines the authorization request.
All other
Note CyberSource Latin American Processing processors:
is the name of a specific processing connection String (60)
that CyberSource supports. In the CyberSource
API documentation, CyberSource Latin
American Processing does not refer to the
general topic of processing in Latin
America.The information in this field description
is for the specific processing connection called
CyberSource Latin American Processing. It is
not for any other Latin American processors
that CyberSource supports.

(continued on next page)

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 252
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_lastName CyberSource through VisaNet
(continued) Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 253
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_merchantTaxID This field is supported only on CyberSource Authorization (R for String (15)
through VisaNet. Mastercard BNDES
transactions in Brazil or
Brazil
Mastercard installment
In Brazil, this field is supported only for BNDES
payments in Croatia;
transactions. See "BNDES," page 129. The
otherwise, not used.)
value for this field is your Cadastro Nacional da
Pessoa Jurídica (CNPJ) number. Capture (R for
Mastercard BNDES
The value for this field corresponds to the
transactions in Brazil or
following data in the TC 33 capture file5:
Mastercard installment
 Record: CP07 TCR6 payments in Croatia;
 Position: 40-59 otherwise, not used.)

 Field: BNDES Reference Field 1 Credit (R for Mastercard

BNDES transactions in
Croatia Brazil; otherwise, not
In Croatia, this field is supported only for used.)
installment payments. See "Installment
Payments on CyberSource through VisaNet,"
page 150.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 79-98
 Field: Mastercard Croatia Domestic Card
Acceptor Tax ID
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 254
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_personalID Identifier for the customer. This field is CyberSource Latin String (26)
supported only on the processors listed in this American Processing:
description. Authorization (See the
field description.)
CyberSource Latin American Processing
This field is supported only for Redecard in CyberSource through
Brazil. Set this field to the Cadastro de Pessoas VisaNet:
Fisicas (CPF), which is required for AVS for
 Authorization (See the
Redecard in Brazil.
field description.)

Note CyberSource Latin American Processing  Capture (See the field

is the name of a specific processing connection description.)
that CyberSource supports. In the CyberSource  Credit (See the field
API documentation, CyberSource Latin description; BNDES
American Processing does not refer to the transactions only.)
general topic of processing in Latin
America.The information in this field description
is for the specific processing connection called
CyberSource Latin American Processing. It is
not for any other Latin American processors
that CyberSource supports.
CyberSource through VisaNet
This field is supported only for these kinds of
payments:
 BNDES transactions. See "BNDES,"
page 129.
 Installment payments with Mastercard in
Brazil. See "Installment Payments on
CyberSource through VisaNet," page 150.
Set this field to the Cadastro de Pessoas
Fisicas (CPF). The request must include this
field or billTo_companyTaxID.
(continued on next page)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 255
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_personalID CyberSource through VisaNet, continued
(continued) For BNDES transactions, the value for this field
corresponds to the following data in the TC 33
capture file5:
 Record: CP07 TCR2
 Position: 7-21
 Field: Cardholder Tax ID
For installment payments with Mastercard in
Brazil, the value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR4
 Position: 26-39
 Field: Buyer ID
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 256
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_phoneNumber Customer’s phone number. CyberSource Authorization (R for Installment
recommends that you include the country code installment payments payments
when the order is from outside the U.S. with Mastercard on with
CyberSource through Mastercard
CyberSource through VisaNet
VisaNet in Brazil; on
Credit card networks cannot process
otherwise, O.) CyberSource
transactions that contain non-ASCII characters.
through
CyberSource through VisaNet accepts and Capture (R for
VisaNet in
stores non-ASCII characters correctly and installment payments
Brazil:
displays them correctly in reports. However, the with Mastercard on
String (11)
limitations of the credit card networks prevent CyberSource through
CyberSource through VisaNet from transmitting VisaNet in Brazil; All other
non-ASCII characters to the credit card otherwise, O.) transactions:
networks. Therefore, CyberSource through String (15)
Credit (O)
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.
For installment payments with Mastercard in
Brazil, the value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR4
 Position: 40-50
 Field: Buyer Phone Number
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 257
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_postalCode Postal code for the billing address. The postal Authorization (R when Comercio
code must consist of 5 to 9 digits. the billing country is the Latino and
U.S. or Canada; CyberSource
When the billing country is the U.S., the 9-digit
otherwise, O.)2 through
postal code must follow this format:
VisaNet:
[5 digits][dash][4 digits] Capture (O)
String (9)
Example 12345-6789 Credit (R when the billing
All other
country is the U.S. or
When the billing country is Canada, the 6-digit processors:
Canada; otherwise,
postal code must follow this format: String (10)
O.)1,2
[alpha][numeric][alpha][space]
[numeric][alpha][numeric]
Example A1B 2C3
American Express Direct
Before sending the postal code to the
processor, CyberSource removes all non-
alphanumeric characters and, if the remaining
value is longer than nine characters, truncates
the value starting from the right side.
Atos
This field must not contain colons (:).
CyberSource through VisaNet
Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 258
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_state State or province of the billing address. Use the Authorization (R when String (2)
State, Province, and Territory Codes for the the billing country is the
United States and Canada. U.S. or Canada;
otherwise, O.)2
CyberSource through VisaNet
Credit card networks cannot process Capture (O)
transactions that contain non-ASCII characters.
Credit (R when the billing
CyberSource through VisaNet accepts and
country is the U.S. or
stores non-ASCII characters correctly and
Canada; otherwise,
displays them correctly in reports. However, the
O.)1,2
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 259
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_street1 First line of the billing street address as it Authorization (R)2 Atos:
appears on the payment card issuer’s records. String (29)
Capture (O)
Atos CyberSource
Credit (R)1,2
This field must not contain colons (:). through
JCN Gateway VisaNet:
CyberSource through VisaNet
Required for String (40)
Important When you populate billing street authorizations and
Moneris:
address 1 and billing street address 2, credits when Decision
String (50)
CyberSource through VisaNet concatenates Manager is included in
the two values. If the concatenated value the request. Otherwise, Worldpay
exceeds 40 characters, CyberSource through optional. VAP:
VisaNet truncates the value at 40 characters String (35)
before sending it to Visa and the issuing bank.
All other
Truncating this value affects AVS results and
processors:
therefore might also affect risk decisions and
String (60)
chargebacks.

Credit card networks cannot process

transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 260
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
billTo_street2 Additional address information. Authorization (O) Atos:
String (29)
Example Capture (O)
CyberSource
Attention: Accounts Payable Credit (O)
through
Atos VisaNet:
This field must not contain colons (:). String (40)
Chase Paymentech Solutions, FDC Moneris:
Compass, and TSYS Acquiring Solutions String (50)
This value is used for AVS.
Worldpay
CyberSource through VisaNet VAP:
String (35)
Important When you populate billing street
All other
address 1 and billing street address 2,
processors:
CyberSource through VisaNet concatenates
String (60)
the two values. If the concatenated value
exceeds 40 characters, CyberSource through
VisaNet truncates the value at 40 characters
before sending it to Visa and the issuing bank.
Truncating this value affects AVS results and
therefore might also affect risk decisions and
chargebacks.
Credit card networks cannot process
transactions that contain non-ASCII characters.
CyberSource through VisaNet accepts and
stores non-ASCII characters correctly and
displays them correctly in reports. However, the
limitations of the credit card networks prevent
CyberSource through VisaNet from transmitting
non-ASCII characters to the credit card
networks. Therefore, CyberSource through
VisaNet replaces non-ASCII characters with
meaningless ASCII characters for transmission
to the credit card networks.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 261
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
businessRules_ List of AVS codes that cause the request to be Authorization (O) String (255)
declineAVSFlags declined for AVS reasons. Use a space to
separate the values in the list.
Important To receive declines for the AVS
code N, include the value N in the list.
businessRules_ Flag for a sale request that indicates whether to Authorization (O) String (5)
ignoreAVSResult allow the capture service to run even when the
authorization receives an AVS decline.
Possible values:
 true: Ignore the results of AVS checking
and run the capture service.
 false (default): If the authorization
receives an AVS decline, do not run the
capture service.
When the value of this field is true, the list in
the businessRules_declineAVSFlags field is
ignored.

businessRules_ Flag for a sale request that indicates whether to Authorization (O) String (5)
ignoreCVResult allow the capture service to run even when the
authorization receives a CVN decline, as
indicated by a ccAuthReply_cvCode value of
D or N.
Possible values:
 true: Ignore the results of CVN checking
and run the capture service.
 false (default): If the authorization
receives a CVN decline, do not run the
capture service.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 262
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
card_accountEncoderID Identifier for the issuing bank that provided the Authorization (R when String (3)
customer’s encoded account number. Contact processing encoded
your processor for the bank’s ID. See "Encoded account numbers;
Account Numbers," page 137. otherwise, not used.)
Credit (R when
processing encoded
account numbers;
otherwise, not used.)1
card_accountNumber Customer’s payment card number. Authorization (R) String with
numbers only
Encoded Account Numbers Credit (R)1
(20)
When processing encoded account numbers,
use this field for the encoded account number.
card_cardType Type of card to authorize. See Appendix G, Authorization String (3)
"Card Types," on page 473 for a list of valid 1
Credit
values. To see which cards are supported for
each processor, see "Payment Processors," Important
page 32. CyberSource strongly
recommends that you
CyberSource through VisaNet
send the card type even
The value for this field corresponds to the
when it is optional for
following data in the TC 33 capture file5:
your processor and card
 Record: CP01 TCR1 type. Omitting the card
type can cause the
 Position: 70-71
transaction to be
 Field: Card ID processed with the
wrong card type.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 263
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
card_cvIndicator Flag indicating whether a CVN code was sent. Authorization (O) String with
Possible values: numbers only
(1)
 0 (default): CVN service not requested.
CyberSource uses this default value when
you do not include card_cvNumber in the
request.
 1 (default): CVN service requested and
supported. CyberSource uses this default
value when you include card_cvNumber in
the request.
 2: CVN on payment card is illegible.
 9: CVN was not imprinted on payment card.
card_cvNumber CVN. See "Card Verification Numbers (CVNs)," Authorization (O) String with
page 97, for a list of processors that support numbers only
CVN. (4)
Ingenico ePayments
Do not include this field when ccAuthService_
commerceIndicator=recurring.
Note Ingenico ePayments was previously
called Global Collect.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 264
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
card_expirationMonth Two-digit month in which the payment card Authorization (R)2 String (2)
expires. 1,2
Credit (R)
Format: MM.
Possible values: 01 through 12.
Barclays and Streamline
For Maestro (UK Domestic) and
Maestro (International) cards on Barclays and
Streamline, this must be a valid value (01
through 12) but is not required to be a valid
expiration date. In other words, an expiration
date that is in the past does not cause
CyberSource to reject the request. However, an
invalid expiration date might cause the issuer to
reject your request.
Encoded Account Numbers
For encoded account numbers (card_
cardType=039), use 12 if there is no
expiration date available.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 265
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
card_expirationYear Four-digit year in which the payment card Authorization (R)2 FDC
expires. 1,2 Nashville
Credit (R)
Format: YYYY. Global and
FDMS South:
Barclays and Streamline
String (See
For Maestro (UK Domestic) and
description)
Maestro (International) cards on Barclays and
Streamline, this must be a valid value (1900 All other
through 3000) but is not required to be a valid processors:
expiration date. In other words, an expiration String (4)
date that is in the past does not cause
CyberSource to reject the request. However, an
invalid expiration date might cause the issuer to
reject your request.
Encoded Account Numbers
For encoded account numbers (card_
cardType=039), if there is no expiration date
available, use 2021.
FDC Nashville Global and FDMS South
You can send in 2 digits or 4 digits. When you
send in 2 digits, they must be the last 2 digits of
the year.
card_issueNumber Number of times a Maestro (UK Domestic) card Authorization (O) String (5)
has been issued to the account holder. The
Credit (O)
card might or might not have an issue number.
The number can consist of one or two digits,
and the first digit might be a zero. When you
include this value in your request, include
exactly what is printed on the card. A value of 2
is different than a value of 02. Do not include
the field, even with a blank value, if the card is
not a Maestro (UK Domestic) card.
Note The issue number is not required for
Maestro (UK Domestic) transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 266
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
card_productName Name of the card product. Possible value: Authorization (O) String (15)
 BNDES
This field is supported only for BNDES
transactions on CyberSource through VisaNet.
See "BNDES," page 129.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR4
 Position: 115-120
 Field: Brazil Country Data
card_startMonth Month of the start of the Authorization (O) String (2)
Maestro (UK Domestic) card validity period. Do
Credit (O)
not include the field, even with a blank value, if
the card is not a Maestro (UK Domestic) card.
Format: MM.
Possible values: 01 through 12.
Note The start date is not required for Maestro
(UK Domestic) transactions.
card_startYear Year of the start of the Maestro (UK Domestic) Authorization (O) String (4)
card validity period. Do not include the field,
Credit (O)
even with a blank value, if the card is not a
Maestro (UK Domestic) card.
Format: YYYY.
Note The start date is not required for Maestro
(UK Domestic) transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 267
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
card_usage Indicates how to use the card for the requested Authorization (O) String (1)
transaction. Possible values:
 C: Credit transaction
 D: Debit transaction
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 51
 Field: Combination Card Transaction
Identifier
This field is supported only for Mastercard
transactions in Brazil on CyberSource through
VisaNet.
cardTypeSelectionIndicator Identifies how the card type was selected. Authorization (R) String (1)
Possible values:
 0: Card type was selected based on default
acquirer settings.
 1: Customer selected the card type.

See "Cartes Bancaires Cards," page 21.

This field is supported only on Credit Mutuel-
CIC.
category_affiliate Indicates an affiliate organization. You can use Authorization (O) String (25)
this information for selective analytics and
Capture (O)
reporting.
Credit (O)
Contact your processor to have your account
enabled for this feature.
This field is supported only on Worldpay VAP.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 268
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
category_campaign Indicates a marketing campaign. You can use Authorization (O) String (25)
this information for selective analytics and
Capture (O)
reporting.
Credit (O)
Contact your processor to have your account
enabled for this feature.
This field is supported only on Worldpay VAP.
category_group Indicates a merchant-defined category or Authorization (O) String (25)
group. You can use this information for
Capture (O)
selective analytics and reporting.
Credit (O)
Contact your processor to have your account
enabled for this feature.
This field is supported only on Worldpay VAP.
ccAuthReversalService_ Request ID for the authorization that you want Authorization Reversal String (26)
authRequestID to reverse. (R)
ccAuthReversalService_ Value of the request token returned from a Authorization Reversal String (256)
authRequestToken previous request for ccAuthService. (O)
The field is an encoded string that contains no
confidential information, such as an account
number or card verification number. The string
can contain a maximum of 256 characters.

ccAuthReversalService_ Reason for the authorization reversal. Possible Authorization Reversal String (3)
reversalReason value: (O)
 34: Suspected fraud
CyberSource ignores this field for processors
that do not support this value.
ccAuthReversalService_run Whether to include the authorization reversal Authorization Reversal String (5)
service in your request. Possible values: (R)
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see
"Reversing an Authorization," page 52.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 269
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Value that identifies you as a payment Authorization American
aggregatorID aggregator. Get this value from the processor. Express
See "Aggregator Support," page 117. Direct:
American Express
String (20)
CyberSource through VisaNet Direct: R for all
The value for this field corresponds to the aggregator transactions. CyberSource
following data in the TC 33 capture file5: through
CyberSource through
VisaNet with
 Record: CP01 TCR6 VisaNet: R for
American
Position: 95-105 Mastercard aggregator
 Express:
transactions and for
 Field: Market Identifier / Payment Facilitator String (20)
American Express
ID aggregator CyberSource
FDC Compass authorizations; through
This value must consist of uppercase otherwise, not used. VisaNet with
characters. Mastercard:
FDC Compass: R for all
String (11)
aggregator transactions.
FDC
FDC Nashville Global: R
Compass:
for all aggregator
String (20)
transactions.
FDC
Nashville
Global: String
(15)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 270
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Your payment aggregator business name. See Authorization: American
aggregatorName "Aggregator Support," page 117. Express
 American Express
Direct:
American Express Direct Direct: R for all
String (see
The maximum length of the aggregator name aggregator
description)
depends on the length of the sub-merchant transactions.
name. The combined length for both values CyberSource
 CyberSource through
must not exceed 36 characters. through
VisaNet: R for
VisaNet:
CyberSource through VisaNet American Express
String (see
With American Express, the maximum length of aggregator
description)
the aggregator name depends on the length of authorizations;
the sub-merchant name. The combined length otherwise, not used. FDC
for both values must not exceed 36 characters. Compass:
 FDC Compass: R for
String (37)
The value for this field does not map to the Mastercard
TC 33 capture file5. aggregator FDC
transactions; Nashville
FDC Compass
otherwise, not used. Global: String
This value must consist of uppercase
(12)
characters.  FDC Nashville Global:
R for all aggregator
transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 271
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_authType Authorization type. Possible values: Authorization (See Comercio
description) Latino: String
 AUTOCAPTURE: automatic capture; see
(15)
"Automatic Captures," page 40.
All other
 STANDARDCAPTURE: standard capture;
processors:
see "Automatic Captures," page 40.
String (11)
 verbal: forced capture; see "Forced
Captures," page 142.
Asia, Middle East, and Africa Gateway;
Cielo; Comercio Latino; and CyberSource
Latin American Processing
Set this field to AUTOCAPTURE and include it
in a bundled request to indicate that you are
requesting an automatic capture. If your
account is configured to enable automatic
captures, set this field to STANDARDCAPTURE
and include it in a standard authorization or
bundled request to indicate that you are
overriding an automatic capture. For more
information, see "Automatic Captures,"
page 40.
Forced Capture
Set this field to verbal and include it in the
authorization request to indicate that you are
performing a forced capture; therefore, you
receive the authorization code outside the
CyberSource system. For more information,
see "Forced Captures," page 142.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 272
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_billPayment Flag indicating that this is a payment for a bill or Authorization (O) String (5)
for an existing contractual loan. See "Visa Bill
Payments," page 229, and "Visa Debt
Repayments," page 230, for lists of processors
that support these features. This value is case
sensitive. Possible values:
 true: Bill payment or loan payment.
 false (default): Not a bill payment or loan
payment.
Note For information about bill payments with
Mastercard, see "Mastercard Bill Payments,"
page 167.
ccAuthService_captureDate Date on which you want the capture to occur. Authorization (O) String (4)
This field is supported only on CyberSource
through VisaNet.
Format: MMDD
ccAuthService_cavv Cardholder authentication verification value Authorization String (40)
(CAVV). For the description and requirements,
see "Payer Authentication," page 186.
ccAuthService_ Algorithm used to generate the CAVV for Visa Authorization String (1)
cavvAlgorithm Secure or the UCAF authentication data for
Mastercard Identity Check. For the description
and requirements, see "Payer Authentication,"
page 186.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 273
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Type of transaction. Some payment card Authorization (R for String (20)
commerceIndicator companies use this information when payer authentication
determining discount rates. transactions; otherwise,
O.)
Ingenico ePayments
Ingenico ePayments was previously called
Global Collect. When you omit this field for
Ingenico ePayments, the processor uses the
default transaction type they have on file for you
instead of the default value listed in Appendix I,
"Commerce Indicators," on page 477.
Payer Authentication Transactions
For the possible values and requirements, see
"Payer Authentication," page 186.
Other Types of Transactions
See Appendix I, "Commerce Indicators," on
page 477.
ccAuthService_ Indicates whether the payment is for the Authorization (O) String (5)
cryptocurrencyPurchase purchase of cryptocurrency. Possible values:
 true: The payment is for the purchase of
cryptocurrency.
 false (default): The payment is not for the
purchase of cryptocurrency.
This field is supported only for Visa transactions
on CyberSource through VisaNet.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 274
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Indicates whether the authorization request Authorization (O) String (5)
deferredAuthIndicator was delayed because connectivity was
interrupted. Possible values:
 true: Deferred authorization.
 false (default): Not a deferred
authorization.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR0
 Position: 160-163
 Field: Message Reason Code
This field is supported only on CyberSource
through VisaNet.
ccAuthService_ Transaction ID generated by the Mastercard Authorization (R for String (36)
directoryServerTransaction directory server during authentication. For more Mastercard Identity
ID information, see "Payer Authentication," Check 2.0 transactions)
page 186.
This field is supported only on CyberSource
through VisaNet and OmniPay Direct.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR7
 Position: 114-149
 Field: MC AVV Verification—Directory Server
Transaction ID
ccAuthService_eciRaw Raw electronic commerce indicator (ECI). For Authorization String (2)
the description and requirements, see "Payer
Authentication," page 186.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 275
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Flag indicating whether this transaction is the Authorization (O) String (5)
firstRecurringPayment first in a series of recurring payments. See
"Recurring Payments," page 207. This field is
supported only on Atos, FDC Nashville Global,
and OmniPay Direct.
Atos and OmniPay Direct
Possible values:
 Y: Yes, this is the first payment in a series of
recurring payments.
 N (default): No, this is not the first payment in
a series of recurring payments.
FDC Nashville Global
Possible values:
 TRUE: Yes, this is the first payment in a
series of recurring payments.
 FALSE (default): No, this is not the first
payment in a series of recurring payments.
ccAuthService_ Indicates whether to request that the processor Authorization (O) String (5)
leastCostRouting use least-cost routing for the transaction. When
the request includes this field, this value
overrides the information in your CyberSource
account. See "Least-Cost Routing (LCR),"
page 164.
Possible values:
 true: Request that the processor use least-
cost routing for the transaction.
 false (default): Do not request that the
processor use least-cost routing for the
transaction.
This field is supported only on Worldpay VAP.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 276
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Indicates whether the transaction is exempt Authorization (O) String (1)
lowValueExemption from strong customer authentication (SCA)
Indicator requirements in Europe because the payment
amount is low. Possible values:
 0 (default): Not exempt.
 1: Exempt from SCA requirements because
the payment amount is low.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR8
 Position: 126
 Field: Low Value Exemption Indicator
This field is supported only in Europe on
CyberSource through VisaNet.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 277
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Type of account that is being used when the Authorization (R for String (4)
overridePayment value for the ccAuthService_ combo card transactions
Details overridePaymentMethod field is line of credit in Brazil on CyberSource
(LI) or prepaid card (PP). through VisaNet;
otherwise, not used.)
Possible values for line of credit:
 AGRC: Visa Agro Custeio
 AGRE: Visa Agro Electron
 AGRI: Visa Agro Investimento
 AGRO: Visa Agro
Possible values for prepaid card:
 VVA: Visa Vale Alimentacao
 VVF: Visa Vale Flex
 VVR: Visa Vale Refeicao
This field is supported only for combo card
transactions in Brazil on CyberSource through
VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 44-47
 Field: Account Accessed

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 278
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Flag that specifies the type of account Authorization (R for String (2)
overridePayment associated with the card. The cardholder combo card transactions
Method provides this information during the payment in Brazil on Cielo,
process. Comercio Latino, and
CyberSource through
Note Combo cards in Brazil contain credit and
VisaNet; otherwise, not
debit functionality in a single card. Visa systems
used.)
use a credit bank identification number (BIN) for
this type of card. Using the BIN to determine
whether a card is debit or credit can cause
transactions with these cards to be processed
incorrectly.
Cielo and Comercio Latino
Possible values:
 CR: Credit card
 DB: Debit card

CyberSource through VisaNet

Possible values:
 CH: Checking account
 CR: Credit card account
 LI: Line of credit or credit portion of combo
card
 PP: Prepaid card or prepaid portion of
combo card
 SA: Savings account

(continued on next page)

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 279
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ For combo card transactions with Mastercard in
overridePaymentMeth Brazil on CyberSource through VisaNet, the
od card_usage field is also supported.
(continued)
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Positions: 42-43
 Field: Account Selection

This field is supported only for transactions with

Brazilian-issued combo cards on Cielo,
Comercio Latino, and CyberSource through
VisaNet.

ccAuthService_paresStatus Payer authentication response status. For the Authorization String (1)
description and requirements, see "Payer
Authentication," page 186.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 280
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Flag indicating whether the transaction is Authorization (O) String (5)
partialAuthIndicator enabled for partial authorization. When the
request includes this field, this value overrides
the information in your CyberSource account.
Possible values:
 true: Enable the transaction for partial
authorization.
 false: Do not enable the transaction for
partial authorization.
See "Partial Authorizations," page 105.
CyberSource through VisaNet
To set the default for this field, contact
CyberSource Customer Support.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR0
 Position: 164
 Field: Additional Authorization Indicators
ccAuthService_ 3D Secure version that was used to process the Authorization (R for String (20)
paSpecificationVersion Mastercard Identity Check transaction. Mastercard Identity
Examples: 1.0.2 or 2.0.0. For more information, Check transactions)
see "Payer Authentication," page 186.
This field is supported only on CyberSource
through VisaNet and OmniPay Direct.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR7
 Position: 113
 Field: MC AVV Verification—Program
Protocol
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 281
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Indicates whether the transaction is exempt Authorization (O) String (1)
riskAnalysisExemption from strong customer authentication (SCA)
Indicator requirements in Europe because it is a low-risk
transaction according to the Payments Service
Directive 2/Regulatory Technical Standards
(PSD2/RTS) regulations. Possible values:
 0 (default): Not exempt.
 1: Exempt from SCA requirements because
the transaction is low risk.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR8
 Position: 127
 Field: Transaction Risk Analysis Exemption
Indicator
This field is supported only in Europe on
CyberSource through VisaNet.
ccAuthService_run Whether to include the authorization service in Authorization (R) String (5)
your request. Possible values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see
"Authorizing a Payment," page 38.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 282
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Indicates whether the transaction is exempt Authorization (O) String (1)
secureCorporatePayment from strong customer authentication (SCA)
Indicator requirements in Europe because the payment
is a secure corporate payment. Possible
values:
 0 (default): Not exempt.
 1: Exempt from SCA requirements because
the payment is a secure corporate payment.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR8
 Position: 129
 Field: Secure Corporate Payment Indicator
This field is supported only in Europe on
CyberSource through VisaNet.
ccAuthService_ Indicates whether the transaction is exempt Authorization (O) String (1)
trustedMerchantExemption from strong customer authentication (SCA)
Indicator requirements in Europe because the merchant
is trusted by the customer. Possible values:
 0 (default): Not exempt.
 1: Exempt from SCA requirements because
the merchant is trusted by the customer.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR8
 Position: 128
 Field: Trusted Merchant Exemption Indicator
This field is supported only in Europe on
CyberSource through VisaNet.
ccAuthService_ Authorization code you received from an Authorization (R for a String (6)
verbalAuthCode authorization that you performed outside the forced capture;
CyberSource system. See "Forced Captures," otherwise, not used.)
page 142.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 283
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccAuthService_ Verification response enrollment status. For the Authorization String (1)
veresEnrolled description and requirements, see "Payer
Authentication," page 186.
ccAuthService_ Type of customer verification data you are Authorization (O) String (2)
verificationType requesting. After receiving the authorization
request, the issuer sends you the type of data
you requested by means of a communication
method or network that does not include
CyberSource through VisaNet. Use the data to
verify the customer's identity. See "Installment
Payments," page 145. Possible values:
 01: Customer's personal data
 02: Customer's age
This field is supported only for Mastercard
installment payments in Poland on
CyberSource through VisaNet.
ccAuthService_xid Transaction identifier. For the description and Authorization String (40)
requirements, see "Payer Authentication,"
page 186.
ccCaptureService_ Value that identifies you as a payment Capture: American
aggregatorID aggregator. Get this value from the processor. Express
 American Express
See "Aggregator Support," page 117. Direct:
Direct: R for all
String (20)
FDC Compass aggregator
This value must consist of uppercase transactions. FDC
characters. Compass:
 CyberSource through
String (20)
VisaNet: not used.
FDC
 FDC Compass: R for
Nashville
all aggregator
Global: String
transactions.
(15)
 FDC Nashville Global:
R for all aggregator
transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 284
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCaptureService_ Your payment aggregator business name. See Capture: American
aggregatorName "Aggregator Support," page 117. Express
 American Express
Direct:
American Express Direct Direct: R for all
String (see
The maximum length of the aggregator name aggregator
description)
depends on the length of the sub-merchant transactions.
name. The combined length for both values FDC
 CyberSource through
must not exceed 36 characters. Compass:
VisaNet: not used.
String (37)
FDC Compass
 FDC Compass: R for
This value must consist of uppercase FDC
Mastercard
characters. Nashville
aggregator
Global: String
transactions;
(12)
otherwise, not used.
 FDC Nashville Global:
R for all aggregator
transactions.
ccCaptureService_ Value of the request ID returned from a Capture (R unless the String (26)
authRequestID previous authorization request. authorization and
capture are included in
the same request.)
ccCaptureService_ Value of the request token returned from a Capture (R for Atos; String (256)
authRequestToken previous request for ccAuthService. otherwise, O.)
The field is an encoded string that contains no Atos
confidential information, such as an account When you request the
number or card verification number. The string authorization and
can contain a maximum of 256 characters. capture together, a
request token is not
required for the capture.
ccCaptureService_authType Authorization type. Capture (O) String (6)
When the transaction contains a verbally
authorized transaction, this field must contain
the value verbal.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 285
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCaptureService_ Dynamic payment descriptor extension (DPDE) Capture (O) String (4)
dpdeBillingMonth that specifies the month for which you are
billing the customer. Depending on your
business model, you might bill for a service that
has already been provided, such as a
telephone service, or you might bill for a service
that is going to be provided, such as a
subscription to investment information. This
value lets the customer know which month the
payment is for.
Format: YYMM
This field is supported only on JCN Gateway
and is not supported for all Japanese acquirers.
ccCaptureService_posData Point-of-sale data. On FDMS South, this field is Capture (See the field String (12)
required for verbal authorizations and forced description.)
captures with the American Express card type
to comply with the CAPN requirements:
 Forced capture: Obtain the value for this field
from the authorization response.
 Verbal authorization: You cannot obtain a
value for this field so CyberSource uses the
default value. The default value is generated
by CyberSource based on various factors of
the transaction such as e-commerce or not,
card present or not, and swiped or keyed.
See "Verbal Authorizations," page 101.
ccCaptureService_run Whether to include the capture service in your Capture (R) String (5)
request. Possible values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see
"Capturing an Authorization," page 61.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 286
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCaptureService_ Capture number when requesting multiple Capture (See "Special Integer (2)
sequence partial captures for one authorization. Used Request Fields for
along with ccCaptureService_totalCount to Multiple Partial
track which capture is being processed. For Captures," page 72.)
example, the second of five captures would be
passed to CyberSource as ccCaptureService_
sequence = 2 and ccCaptureService_
totalCount = 5.
For the list of processors that support this field,
see "Special Request Fields for Multiple Partial
Captures," page 72.
ccCaptureService_ Total number of captures when requesting Capture (See "Special Integer (2)
totalCount multiple partial captures for one authorization. Request Fields for
Used along with ccCaptureService_sequence Multiple Partial
to track which capture is being processed. For Captures," page 72.)
example, the second of five captures would be
passed to CyberSource as ccCaptureService_
sequence = 2 and ccCaptureService_
totalCount = 5.
For the list of processors that support this field,
see "Special Request Fields for Multiple Partial
Captures," page 72.
ccCaptureService_ Transaction ID (TID). On FDMS South, this field Capture (See the field String (15)
transactionID is required for verbal authorizations and forced description.)
captures with the American Express card type
to comply with the CAPN requirements:
 Forced capture: Obtain the value for this field
from the authorization response.
 Verbal authorization: You cannot obtain a
value for this field so CyberSource uses the
default value of 000000000000000 (15
zeros). See "Verbal Authorizations,"
page 101, for important information about
using this default value.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 287
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCaptureService_ Verbally received authorization code. Capture (O) JCN
verbalAuthCode Gateway:
String (7)
All other
processors:
String (6)
ccCheckStatusService_ Request ID for the authorization that you want Check Status (R) String (26)
authRequestID to check.
ccCheckStatusService_run Whether to include the check status service in Check Status (R) String (5)
your request. Possible values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see
"Checking the Status of an Authorization
Request," page 44.
ccCreditService_ Value that identifies you as a payment Credit: American
aggregatorID aggregator. Get this value from the processor. Express
 American Express
See "Aggregator Support," page 117. Direct:
Direct: R for all
String (20)
FDC Compass aggregator
This value must consist of uppercase transactions. FDC
characters. Compass:
 CyberSource through
String (20)
VisaNet: not used.
FDC
 FDC Compass: R for
Nashville
all aggregator
Global: String
transactions.
(15)
 FDC Nashville Global:
R for all aggregator
transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 288
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCreditService_ Your payment aggregator business name. See Credit: American
aggregatorName "Aggregator Support," page 117. Express
 American Express
Direct:
American Express Direct Direct: R for all
String (see
The maximum length of the aggregator name aggregator
description)
depends on the length of the sub-merchant transactions.
name. The combined length for both values FDC
 CyberSource through
must not exceed 36 characters. Compass:
VisaNet: not used.
String (37)
FDC Compass
 FDC Compass: R for
This value must consist of uppercase FDC
Mastercard
characters. Nashville
aggregator
Global: String
transactions;
(12)
otherwise, not used.
 FDC Nashville Global:
R for all aggregator
transactions.
ccCreditService_billPayment Flag indicating whether this is a credit for a bill Credit (O) String (5)
that the customer paid with a Visa card. See
"Visa Bill Payments," page 229, for a list of
processors that support bill payments with Visa.
This value is case sensitive. Possible values:
 true: Credit for a bill payment.
 false (default): Not a credit for a bill
payment
ccCreditService_ Value of the request ID returned from a Credit (O) String (26)
captureRequestID previous request for ccCaptureService.
Creates a follow-on credit by linking the credit
to the previous capture. When you send this
field, you do not need to send several other
credit request fields. See "Crediting a
Payment," page 78, for a description of follow-
on credits.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 289
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCreditService_ Value of the request token returned from a Credit (R for Atos; String (256)
captureRequestToken previous request for ccCaptureService. otherwise, O.)
The field is an encoded string that contains no
confidential information, such as an account
number or card verification number. The string
can contain a maximum of 256 characters.

ccCreditService_ Type of transaction. Use with stand-alone Credit (R for stand-alone String (13)
commerceIndicator credits. Some payment card companies use credits on Chase
this information when determining discount Paymentech solutions;
rates. Possible values: otherwise, optional.)
 internet
 moto
 recurring
 recurring_internet
For details about these values, see Appendix I,
"Commerce Indicators," on page 477.
ccCreditService_ Dynamic payment descriptor extension (DPDE) Credit (O) String (4)
dpdeBillingMonth that specifies the month for which you are
billing the customer. Depending on your
business model, you might bill for a service that
has already been provided, such as a
telephone service, or you might bill for a service
that is going to be provided, such as a
subscription to investment information. This
value lets the customer know which month the
payment is for.
Format: YYMM
This field is supported only on JCN Gateway
and is not supported for all Japanese acquirers.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 290
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCreditService_ Type of account that is being used when the Credit (R for combo card String (4)
overridePayment value for the ccCreditService_ transactions in Brazil on
Details overridePaymentMethod field is line of credit CyberSource through
(LI) or prepaid card (PP). VisaNet; otherwise, not
used.)
Possible values for line of credit:
 AGRC: Visa Agro Custeio
 AGRE: Visa Agro Electron
 AGRI: Visa Agro Investimento
 AGRO: Visa Agro
Possible values for prepaid card:
 VVA: Visa Vale Alimentacao
 VVF: Visa Vale Flex
 VVR: Visa Vale Refeicao
This field is supported only for combo card
transactions in Brazil on CyberSource through
VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 44-47
 Field: Account Accessed

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 291
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCreditService_ Flag that specifies the type of account Credit (R for combo card String (2)
overridePayment associated with the card. The cardholder transactions in Brazil on
Method provides this information during the payment CyberSource through
process. VisaNet; otherwise, not
used.)
Note Combo cards in Brazil contain credit and
debit functionality in a single card. Visa systems
use a credit bank identification number (BIN) for
this type of card. Using the BIN to determine
whether a card is debit or credit can cause
transactions with these cards to be processed
incorrectly.
Possible values:
 CH: Checking account
 CR: Credit card account
 LI: Line of credit or credit portion of combo
card
 PP: Prepaid card or prepaid portion of
combo card
 SA: Savings account

For combo card transactions with Mastercard in

Brazil on CyberSource through VisaNet, the
card_usage field is also supported.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Positions: 42-43
 Field: Account Selection

This field is supported only for transactions with

Brazilian-issued combo cards on CyberSource
through VisaNet.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 292
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccCreditService_run Whether to include the credit service in your Credit (R) String (5)
request. Possible values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see
"Crediting a Payment," page 78.
ccIncrementalAuthService_ Request ID for the original authorization that Incremental String (26)
authRequestID you want to increment. See "Incremental Authorization (R)
Authorizations," page 45.
ccIncrementalAuthService_ Number of days that the customer plans to stay Incremental String (2)
duration at the lodging. For a lodging deposit, the value Authorization (O)
for this field specifies the number of days
covered by the advance payment. See
"Incremental Authorizations," page 45.
Possible values: 01 through 99.
ccIncrementalAuthService_ Whether to include the incremental Incremental String (5)
run authorization service in your request. Possible Authorization (R)
values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see
"Incremental Authorizations," page 45.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 293
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
ccIncrementalAuthService_ Local date and time at your physical location. Incremental String (14)
transactionLocalDateTime Include both the date and time in this field or Authorization (O)
leave it blank.
Format: YYYYMMDDhhmmss
where:
 YYYY = year
 MM = month
 DD = day
 hh = hour
 mm = minutes
 ss = seconds
dcc_dccIndicator Flag indicating that DCC is being used for the Authorization (R for DCC String (1)
transaction. Set this field to 1. For details, see transactions)
"Dynamic Currency Conversion with a Third
Party Provider," page 133.
dcc_referenceNumber Unique identifier generated by the DCC Authorization (O) String (60)
provider. For details, see "Dynamic Currency
Conversion with a Third Party Provider,"
page 133.
debtIndicator Flag indicating whether this is a payment Authorization (O) String (5)
towards an existing contractual loan. See "Visa
Credit (O)
Debt Repayments," page 230, for a list of
processors that support this feature. Possible
values:
 true: Loan payment
 false (default): Not a loan payment
eligibilityInquiry Indicates whether the authorization request is a Authorization (R for String (9)
Crediario eligibility inquiry. See "Installment Crediario eligibility
Payments on CyberSource through VisaNet," inquiry; otherwise, not
page 150. used.)
Set the value for this field to Crediario.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 294
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
extendedCreditTotalCount Number of months over which the cardholder Authorization (O) String (2)
can pay for the purchase. You can use this field
when offering extended credit to a cardholder at
a retail location. The cardholder provides this
value. The issuer pays you for the purchase in
one payment, and then the cardholder pays the
issuer in the number of monthly payments
specified by this value.
Note This field is supported only for acquirers
in South Africa and only for CyberSource
through VisaNet.

installment_additionalCosts Additional costs charged by the issuer to fund Capture (R for Crediario String (12)
the installment payments. installment payments in
Brazil on CyberSource
This field is included in the authorization reply
through VisaNet)
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 128-139
 Field: Total Other Costs
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 295
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Additional costs divided by the amount funded. Capture (R for Crediario String (4)
additionalCostsPercentage For example: installment payments in
Brazil on CyberSource
 A value of 1.0 specifies 1%.
through VisaNet)
 A value of 4.0 specifies 4%.
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 140-143
 Field: Percent of Total Other Costs
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 296
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_amount Amount for the current installment payment. Authorization (R for String (12)
This field is supported only on CyberSource Crediario eligibility
through VisaNet. inquiries in Brazil and
installment payments in
Brazil
Georgia; otherwise, O.)
In Brazil, this field is supported for Crediario
installment payments. See "Installment Capture (O)
Payments on CyberSource through VisaNet,"
page 150.
When you do not include this field in a request
for a Crediario installment payment,
CyberSource sends a value of 0 to the
processor.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 26-37
 Field: Amount of Each Installment
Georgia (Sakartvelo)
In Georgia, this field is supported for installment
payments. See "Installment Payments on
CyberSource through VisaNet," page 150.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 63-74
 Field: Mastercard Subsequent Installment
Amount
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 297
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_amountFunded Amount funded. Capture (R for Crediario String (12)
installment payments in
This field is included in the authorization reply
Brazil on CyberSource
for the Crediario eligibility request when the
through VisaNet)
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 48-59
 Field: Total Amount Funded
installment_ Amount requested divided by the amount Capture (R for Crediario String (4)
amountRequested funded. For example: installment payments in
Percentage Brazil on CyberSource
 A value of 90.0 specifies 90%.
through VisaNet)
 A value of 93.7 specifies 93.7%.
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 60-63
 Field: Percent of Amount Requested
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 298
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Annual cost of financing the installment Capture (R for Crediario String (7)
annualFinancingCost payments. installment payments in
Brazil on CyberSource
This field is included in the authorization reply
through VisaNet)
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 158-164
 Field: Annual Total Cost of Financing
installment_ Annual interest rate. For example: Capture (R for Crediario String (7)
annualInterestRate installment payments in
 A value of 1.0 specifies 1%.
Brazil on CyberSource
 A value of 4.0 specifies 4%. through VisaNet)
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 151-157
 Field: Annual Interest Rate
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 299
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_downPayment Down payment. Authorization (O) String (12)
This field is supported only for airline
transactions on Getnet.
installment_expenses Expenses charged by the issuer to fund the Capture (R for Crediario String (12)
installment payments. installment payments in
Brazil on CyberSource
This field is included in the authorization reply
through VisaNet)
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 64-75
 Field: Total Expenses
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 300
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Expenses divided by the amount funded. For Capture (R for Crediario String (4)
expensesPercentage example: installment payments in
Brazil on CyberSource
 A value of 1.0 specifies 1%.
through VisaNet)
 A value of 4.0 specifies 4%.
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 76-79
 Field: Percent of Total Expenses
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 301
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_fees Fees charged by the issuer to fund the Capture (R for Crediario String (12)
installment payments. installment payments in
Brazil on CyberSource
This field is included in the authorization reply
through VisaNet)
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 80-91
 Field: Total Fees
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 302
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_feesPercentage Fees divided by the amount funded. For Capture (R for Crediario String (4)
example: installment payments in
Brazil on CyberSource
 A value of 1.0 specifies 1%.
through VisaNet)
 A value of 4.0 specifies 4%.
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 92-95
 Field: Percent of Total Fees
installment_ Amount of the first installment payment. This Authorization (R for String (12)
firstInstallmentAmount field is supported only for Mastercard installment payments in
installment payments in Georgia (Sakartvelo) Georgia; otherwise, not
on CyberSource through VisaNet. See used.)
"Installment Payments on CyberSource through
VisaNet," page 150.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 23-34
 Field: Amount of Each Installment
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 303
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Date of the first installment payment. When you Authorization (R for String (6)
firstInstallmentDate do not include this field, CyberSource sends a Crediario eligibility
string of six zeros (000000) to the processor. inquiry; otherwise, O.)
See "Installment Payments on CyberSource
Capture (O)
through VisaNet," page 150.
Format: YYMMDD.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 42-47
 Field: Date of First Installment
installment_frequency Frequency of the installment payments. When Authorization (R for String (1)
you do not include this field in a request for a Crediario eligibility
Crediario installment payment, CyberSource inquiries; otherwise, O.)
sends a space character to the processor. This
Capture (O)
field is supported only on CyberSource through
VisaNet. Possible values:
 B: Biweekly
 M: Monthly
 W: Weekly
See "Installment Payments on CyberSource
through VisaNet," page 150.
For Crediario installment payments, the value
for this field corresponds to the following data in
the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 41
 Field: Installment Frequency
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 304
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Grace period requested by the customer before Authorization (R for String (2)
gracePeriodDuration the first installment payment is due. When you Mastercard installment
include this field in a request, you must also payments in Greece and
include the grace period duration type field. See O for Mastercard
"Installment Payments on CyberSource through installment payments in
VisaNet," page 150. Brazil; otherwise, not
used.)
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 100-101
 Field: Mastercard Grace Period Details
This field is supported only for Mastercard
installment payments in Brazil and Greece on
CyberSource through VisaNet.
installment_ Unit for the requested grace period duration. Authorization (R when String (1)
gracePeriodDurationType See "Installment Payments on CyberSource the grace period duration
through VisaNet," page 150. Possible values: field is included;
otherwise, not used.)
 D: Days
 W: Weeks
 M: Months
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 99
 Field: Mastercard Grace Period Details
This field is supported only for Mastercard
installment payments in Brazil and Greece on
CyberSource through VisaNet.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 305
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_insurance Insurance charged by the issuer to fund the Capture (R for Crediario String (12)
installment payments. installment payments in
Brazil on CyberSource
This field is included in the authorization reply
through VisaNet)
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 112-123
 Field: Total Insurance
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 306
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Insurance costs divided by the amount funded. Capture (R for Crediario String (4)
insurancePercentage For example: installment payments in
Brazil on CyberSource
 A value of 1.0 specifies 1%.
through VisaNet)
 A value of 4.0 specifies 4%.
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 124-127
 Field: Percent Of Total Insurance
installment_invoiceData Invoice information that you want to provide to Authorization (O) String (20)
the issuer. This value is similar to a tracking
Capture (O)
number and is the same for all installment
payments for one purchase.
This field is supported only for installment
payments with Mastercard on CyberSource
through VisaNet in Brazil. See "Installment
Payments on CyberSource through VisaNet,"
page 150.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR4
 Position: 51-70
 Field: Purchase Identification
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 307
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Monthly interest rate. For example: Capture (R for Crediario String (7)
monthlyInterestRate installment payments in
 A value of 1.0 specifies 1%.
Brazil and for installment
 A value of 4.0 specifies 4%. payments in Georgia)
This field is supported only for installment
payments on CyberSource through VisaNet.
See "Installment Payments on CyberSource
through VisaNet," page 150.
Brazil
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 144-150
 Field: Monthly Interest Rate
Georgia (Sakartvelo)
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 41-45
 Field: Mastercard Interest Rate
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 308
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_paymentType Payment plan for the installments. This field is Authorization (R for String (1)
supported only for installment payments on installment payments in
CyberSource through VisaNet. See "Installment all countries except
Payments on CyberSource through VisaNet," Brazil, Croatia, Georgia,
page 150. and Greece; O for
installment payments in
Possible values:
Brazil; otherwise, not
 0 (default): Regular installment. This value is used.)
not allowed for airline transactions.
Capture (R for
 1: Installment payment with down payment. installment payments in
 2: Installment payment without down all countries except
payment. This value is supported only for Brazil, Croatia, Georgia,
airline transactions. and Greece; O for
installment payments in
 3: Installment payment; down payment and Brazil; otherwise, not
boarding fee will follow. This value is used.)
supported only for airline transactions.
 4: Down payment only; regular installment
payment will follow.
 5: Boarding fee only. This value is supported
only for airline transactions.
Brazil
In Brazil, this field is supported only for
installment payments with Visa.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR1
 Position: 9
 Field: Merchant Installment Supporting
Information
(continued on next page)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 309
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_paymentType Rest of World
(continued) In all countries except Brazil, Croatia, Georgia,
and Greece, this field is supported only for
installment payments with Mastercard.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 35-37
 Field: Installment Payment Number
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 310
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_planType American Express Direct, Cielo, and Authorization (R for CyberSource
CyberSource Latin American Processing installment payments through
Flag indicating the type of funding for the with Visa or Mastercard VisaNet:
installment plan associated with the payment. on CyberSource through String (2)
Possible values: VisaNet in Brazil;
All other
otherwise, O.)
 1: Merchant-funded installment plan processors:
Capture (R for String (1)
 2: Issuer-funded installment plan
installment payments
When you do not include this field in the with Visa or Mastercard
request, CyberSource uses the value in your on CyberSource through
CyberSource account. To change the value in VisaNet in Brazil;
your CyberSource account, contact otherwise, O.)
CyberSource Customer Service. See
"Installment Payments," page 145.
CyberSource through VisaNet with
American Express
American Express-defined code that indicates
the type of installment plan for this transaction.
Contact American Express for:
 Information about the kinds of installment
plans that American Express provides
 Values for this field
See "Installment Payments on CyberSource
through VisaNet," page 150.
For installment payments with American
Express in Brazil, the value for this field
corresponds to the following data in the TC 33
capture file5:
 Record: CP07 TCR3
 Position: 5-6
 Field: Plan Type
(continued on next page)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 311
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_planType CyberSource through VisaNet with Visa or
(continued) Mastercard
Flag indicating the type of funding for the
installment plan associated with the payment.
Possible values:
 1 or 01: Merchant-funded installment plan
 2 or 02: Issuer-funded installment plan
 3 or 03: Co-branded merchant financed—
only with Mastercard in Brazil
 4 or 04: Issuer merchant co-financed—only
with Mastercard in Brazil
 43: Crediario installment plan—only with
Visa in Brazil
See "Installment Payments on CyberSource
through VisaNet," page 150.
For installment payments with Visa in Brazil, the
value for this field corresponds to the following
data in the TC 33 capture file5:
 Record: CP07 TCR1
 Position: 5-6
 Field: Installment Type
For all other kinds of installment payments, the
value for this field corresponds to the following
data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 39-40
 Field: Installment Plan Type
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 312
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_sequence Installment number when making payments in Authorization: Integer (2)
installments. Used along with installment_
 Chase Paymentech
totalCount to track which payment is being
Solutions and FDC
processed. For example, the second of 5
Compass: O.
payments would be passed to CyberSource as
installment_sequence = 2 and installment_  CyberSource Latin
totalCount = 5. See "Installment Payments," American Processing
page 145. in Brazil: Not used.

Chase Paymentech Solutions and FDC  CyberSource through

Compass VisaNet: R for
This field is optional because this value is Crediario eligibility
required in the merchant descriptors. See inquiries; otherwise,
Merchant Descriptors Using the Simple Order O.
API.  All other processors:
CyberSource through VisaNet R for installment
When you do not include this field in a request payments.
for a Crediario installment payment, Capture (R for Crediario
CyberSource sends a value of 0 to the eligibility inquiries on
processor. CyberSource through
For Crediario installment payments, the value VisaNet; otherwise, not
for this field corresponds to the following data in used.)
the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 38-40
 Field: Installment Payment Number
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 313
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_taxes Taxes collected by the issuer to fund the Capture (R for Crediario String (12)
installment payments. installment payments in
Brazil on CyberSource
This field is included in the authorization reply
through VisaNet)
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 96-107
 Field: Total Taxes
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 314
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_ Taxes divided by the amount funded. For Capture (R for Crediario String (4)
taxesPercentage example: installment payments in
Brazil on CyberSource
 A value of 1.0 specifies 1%.
through VisaNet)
 A value of 4.0 specifies 4%.
This field is included in the authorization reply
for the Crediario eligibility request when the
issuer approves the customer's request for
Crediario installment payments in Brazil. See
"Installment Payments on CyberSource through
VisaNet," page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR9
 Position: 108-111
 Field: Percent of Total Taxes
installment_totalAmount Total amount of the loan that is being paid in Authorization (R for String (12)
installments. This field is supported only on Crediario eligibility
CyberSource through VisaNet. See "Installment inquiries and installment
Payments," page 145. payments in Brazil on
CyberSource through
VisaNet)
Capture (R for Crediario
installment payments in
Brazil on CyberSource
through VisaNet)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 315
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_totalCount Total number of installments when making Authorization: Integer (2)
payments in installments. See "Installment
 Chase Paymentech
Payments," page 145.
Solutions,
Chase Paymentech Solutions and FDC CyberSource Latin
Compass American Processing,
This field is optional because this value is and FDC Compass:
required in the merchant descriptors. See O.
Merchant Descriptors Using the Simple Order
 CyberSource through
API.
VisaNet:
American Express Direct, Cielo, and  In Brazil: R for Visa
Comercio Latino and for Crediario
This value is the total number of installments eligibility inquiries;
that you approved. otherwise, O.
CyberSource Latin American Processing in  In all countries
Brazil except Brazil: R in
This value is the total number of installments Georgia and
that you approved. The default is 1. Greece; otherwise,
O.
All Other Processors
This value is used along with installment_  All other processors:
sequence to track which payment is being R for installment
processed. For example, the second of 5 payments.
payments would be passed to CyberSource as Capture:
installment_sequence = 2 and installment_
totalCount = 5.  Chase Paymentech
Solutions,
CyberSource through VisaNet in Brazil CyberSource Latin
For installment payments with Mastercard and American Processing,
for Crediario installment payments with Visa, and FDC Compass:
the value for this field corresponds to the O.
following data in the TC 33 capture file5:
 CyberSource through
 Record: CP01 TCR9 VisaNet:
 Position: 23-25  In Brazil: R for Visa
 Field: Number of Installments and for Crediario
eligibility inquiries;
(continued on next page) otherwise, O.
 In all countries
except Brazil: R in
Georgia and
Greece; otherwise,
O.
 All other processors:
R for installment
payments.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
Credit Card Services Using the Simple Order API | September 2019 316
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
installment_totalCount For installment payments with American
(continued) Express or with Visa, the value for this field
corresponds to the following data in the TC 33
capture file5:
 Record: CP07 TCR3
 Position: 7-8
 Field: Number of Installments
CyberSource through VisaNet in All
Countries Except Brazil
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR5
 Position: 20-22
 Field: Number of Installments
invoiceHeader_ Four Transaction Advice Addendum (TAA) Capture (O) String (40)
amexDataTAA1 fields. These fields are used to display
Credit (O)
descriptive information about a transaction on
invoiceHeader_
the customer’s American Express card
amexDataTAA2
statement. When you send TAA fields, start with
invoiceHeader_ invoiceHeader_amexDataTAA1, then ...TAA2,
amexDataTAA3 and so on. Skipping a TAA field causes
invoiceHeader_ subsequent TAA fields to be ignored.
amexDataTAA4 To use these fields, contact CyberSource
Customer Support to have your account
enabled for this feature.
For information about merchant descriptors,
including which processors support this field,
see "Merchant Descriptors," page 169.
These fields are frequently used for Level II
transactions. See Level II and Level III
Processing Using the Simple Order API.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 317
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Type of transaction. For a list of possible Authorization (O) String (2)
businessApplicationID values, see Appendix F, "Business Application
Identifiers," on page 472.
This field is a pass-through, which means that
CyberSource does not verify the value or
modify it in any way before sending it to the
processor.
When the request includes this field, this value
overrides the information in your CyberSource
account.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR8
 Position: 108-109
 Field: Business Application Identifier (BAI)
invoiceHeader_ Free form data about the transaction. Authorization (O) String (32)
customData_1 CyberSource forwards this value to your
Capture (O)
processor, which then forwards the value to
your acquirer during settlement.
When you send this field for both the
authorization and capture services,
CyberSource forwards the value sent in the
capture request.
This field is supported only on FDC Nashville
Global.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 318
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Company ID assigned to an independent sales Authorization (R for Nonnegative
salesOrganizationID organization. Get this value from Mastercard. Mastercard aggregator integer (11)
See "Aggregator Support," page 117. transactions on
CyberSource through
CyberSource through VisaNet
VisaNet; otherwise, not
The value for this field corresponds to the
used.)
following data in the TC 33 capture file5:
 Record: CP01 TCR6
 Position: 106-116
 Field: Independent Sales Organization ID
invoiceHeader_ Sub-merchant’s city. See "Aggregator Support," Authorization, Capture, American
submerchantCity page 117. Credit: Express
Direct:
CyberSource through VisaNet  American Express
String (14)
The value for this field does not map to the Direct: R for all
TC 33 capture file5. aggregator CyberSource
transactions. through
FDC Compass
VisaNet:
This value must consist of uppercase  CyberSource through
String (14)
characters. VisaNet: R for
American Express FDC
aggregator Compass:
authorizations; String (21)
otherwise, not used.
FDC
 FDC Compass: R for Nashville
all aggregator Global: String
transactions. (11)
 FDC Nashville Global:
R for all aggregator
transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 319
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Sub-merchant’s country. Use the two-character Authorization, Capture, String (3)
submerchantCountry ISO Standard Country Codes. See "Aggregator Credit:
Support," page 117.
 American Express
CyberSource through VisaNet Direct: R for all
The value for this field does not map to the aggregator
TC 33 capture file5. transactions.
FDC Compass  CyberSource through
This value must consist of uppercase VisaNet: O for
characters. American Express
aggregator
authorizations;
otherwise, not used.
 FDC Compass: O for
all aggregator
transactions.
 FDC Nashville Global:
R for all aggregator
transactions.
invoiceHeader_ Sub-merchant’s email address. See Authorization, Capture, American
submerchantEmail "Aggregator Support," page 117. Credit: Express
Direct: String
CyberSource through VisaNet  American Express
(40)
With American Express, the value for this field Direct: R for all
corresponds to the following data in the TC 33 aggregator CyberSource
capture file5: transactions. through
VisaNet:
 Record: CP01 TCRB  CyberSource through
String (40)
VisaNet: O for all
 Position: 25-64
aggregator FDC
 Field: American Express Seller E-mail transactions with Compass:
Address American Express; String (40)
otherwise, not used.
FDC
 FDC Compass: O for Nashville
all aggregator Global: String
transactions. (19)
 FDC Nashville Global:
R for all aggregator
transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 320
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ The ID you assigned to your sub-merchant. Authorization, Capture, American
submerchantID See "Aggregator Support," page 117. Credit: Express
Direct: String
CyberSource through VisaNet  American Express
(20)
With American Express, the value for this field Direct: R for all
corresponds to the following data in the TC 33 aggregator CyberSource
capture file5: transactions. through
VisaNet with
 Record: CP01 TCRB  CyberSource through
American
VisaNet:
 Position: 65-84 Express:
 O for all American
 Field: American Express Seller ID String (20)
Express
With Visa and Mastercard, the value for this aggregator CyberSource
field corresponds to the following data in the TC transactions; through
33 capture file5:  R for all Mastercard VisaNet with
aggregator Mastercard:
 Record: CP01 TCR6 String (15)
authorizations;
 Position: 117-131 FDC
 Otherwise, not
 Field: Sub-Merchant ID used. Compass:
String (20)
FDC Compass  FDC Compass: R for
This value must consist of uppercase all aggregator FDC
characters. transactions. Nashville
Global: String
 FDC Nashville Global:
(14)
R for all aggregator
transactions.W
invoiceHeader_submerchant Unique identifier assigned by the payment card Authorization: String (15)
MerchantID company to the sub-merchant. See "Aggregator
 American Express
Support," page 117.
Direct: not used.
 CyberSource through
VisaNet: not used.
 FDC Compass: not
used.
 FDC Nashville Global:
O for American
Express aggregator
authorizations;
otherwise, not used.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 321
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Sub-merchant’s business name. See Authorization, Capture, American
submerchantName "Aggregator Support," page 117. Credit: Express
Direct: String
American Express Direct  American Express
(see
The maximum length of the sub-merchant Direct: R for all
description)
name depends on the length of the aggregator aggregator
name. The combined length for both values transactions. CyberSource
must not exceed 37 characters. through
 CyberSource through
VisaNet:
CyberSource through VisaNet VisaNet: R for
String (see
With American Express, the maximum length of American Express
description)
the sub-merchant name depends on the length aggregator
of the aggregator name. The combined length authorizations; FDC
for both values must not exceed 37 characters. otherwise, not used. Compass
The value for this field corresponds to the with
 FDC Compass: R for
following data in the TC 33 capture file5: American
all aggregator
Record: CP01 TCRB Express:
 transactions.
String (19)
 Position: 109-146  FDC Nashville Global:
Field: American Express Seller Name FDC
 R for all aggregator
Compass
FDC Compass transactions.
with
This value must consist of uppercase Mastercard:
characters. String (37)
FDC Nashville Global FDC
With Mastercard, the maximum length of the Nashville
sub-merchant name depends on the length of Global with
the aggregator name: American
 If aggregator name length is 1 through 3, Express:
maximum sub-merchant name length is 21. String (12)

 If aggregator name length is 4 through 7, FDC

maximum sub-merchant name length is 17. Nashville
Global with
 If aggregator name length is 8 through 12,
Mastercard:
maximum sub-merchant name length is 12.
String (see
description)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 322
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Partial postal code for the sub-merchant’s Authorization, Capture, American
submerchantPostalCode address. See "Aggregator Support," page 117. Credit: Express
Direct: String
CyberSource through VisaNet  American Express
(10)
The value for this field does not map to the Direct: R for all
TC 33 capture file5. aggregator CyberSource
transactions. through
FDC Compass
VisaNet:
This value must consist of uppercase  CyberSource through
String (10)
characters. VisaNet: O for
American Express FDC
aggregator Compass:
authorizations; String (15)
otherwise, not used.
FDC
 FDC Compass: O for Nashville
all aggregator Global: String
transactions. (9)
 FDC Nashville Global:
R for all aggregator
transactions.
invoiceHeader_ Sub-merchant’s region. See "Aggregator Authorization: String (3)
submerchantRegion Support," page 117.
 American Express
Example NE indicates that the sub-merchant Direct: not used.
is in the northeast region.
 CyberSource through
VisaNet: not used.
 FDC Compass: not
used.
 FDC Nashville Global:
O for all aggregator
authorizations;
otherwise, not used.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 323
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Sub-merchant’s state or province. Use the Authorization, Capture, String (3)
submerchantState State, Province, and Territory Codes for the Credit:
United States and Canada. See "Aggregator
 American Express
Support," page 117.
Direct: R for all
CyberSource through VisaNet aggregator
The value for this field corresponds to the transactions.
following data in the TC 33 capture file5:
 CyberSource through
 Record: CP01 TCR4 VisaNet: O for
 Position: 164-166 American Express
 Field: Region Code aggregator
authorizations;
FDC Compass
otherwise, not used.
This value must consist of uppercase
characters.  FDC Compass: O for
all aggregator
transactions.
 FDC Nashville Global:
R for all aggregator
transactions.
invoiceHeader_ First line of the sub-merchant’s street address. Authorization, Capture, American
submerchantStreet See "Aggregator Support," page 117. Credit: Express
Direct: String
CyberSource through VisaNet  American Express
(29)
The value for this field does not map to the Direct: R for all
TC 33 capture file5. aggregator CyberSource
transactions. through
FDC Compass
VisaNet:
This value must consist of uppercase  CyberSource through
String (29)
characters. VisaNet: R for
American Express FDC
aggregator Compass:
authorizations; String (38)
otherwise, not used.
FDC
 FDC Compass: O for Nashville
all aggregator Global: String
transactions. (25)
 FDC Nashville Global:
R for all aggregator
transactions.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 324
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
invoiceHeader_ Sub-merchant’s telephone number. See Authorization, Capture, American
submerchantTelephone "Aggregator Support," page 117. Credit: Express
Number Direct: String
CyberSource through VisaNet  American Express
(20)
With American Express, the value for this field Direct: R for all
corresponds to the following data in the TC 33 aggregator CyberSource
capture file5: transactions. through
VisaNet:
 Record: CP01 TCRB  CyberSource through
String (20)
VisaNet: O for all
 Position: 5-24
aggregator FDC
 Field: American Express Seller Telephone transactions with Compass:
Number American Express; String (13)
FDC Compass otherwise, not used.
FDC
This value must consist of uppercase  FDC Compass: R for Nashville
characters. Use one of these recommended all aggregator Global: String
formats: transactions. (10)
NNN-NNN-NNNN
 FDC Nashville Global:
NNN-AAAAAAA
R for all aggregator
transactions.
issuer_additionalData Data defined by the issuer. For more Authorization (O) String (255)
information, see Appendix N, "Formats for
Authorization Reversal For an
Discretionary Data," on page 487.
(O) authorization,
This field is supported only for Visa and the maximum
Capture (O)
Mastercard on CyberSource through VisaNet. length for this
value is 255
CyberSource through VisaNet
characters. In
The value for this field corresponds to the
the capture
following data in the TC 33 capture file5:
file, the value
 Record: CP08 TCR1 is truncated
 Position: 9-168 at 161
characters.
 Field: Free Form Text
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 325
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
item_#_productCode Type of product. This value is used to Authorization (O) String (255)
determine the category that the product is in:
Capture (O)
electronic, handling, physical, service, or
shipping. The default value is default. See Credit (O)
Table 74, "Product Codes," on page 500 for a
list of valid values.
For ccAuthService, when you set this field to a
value other than default or any of the values
related to shipping and/or handling, the item_
#_quantity, item_#_productName, and item_
#_productSKU fields are required.
See "Numbered Elements," page 242.
item_#_productName For authorizations and captures, this field is Authorization (See the String (255)
required when item_#_productCode is not field description.)
default or one of the values related to Capture (See the field
shipping and/or handling.
description.)
See "Numbered Elements," page 242.
item_#_productSKU Identification code for the product. For Authorization (See the String (255)
authorizations and captures, this field is field description.)
required when item_#_productCode is not
Capture (See the field
default or one of the values related to
description.)
shipping and/or handling.
See "Numbered Elements," page 242.
item_#_quantity The default is 1. For authorizations and Authorization (See the Integer (10)
captures, this field is required when item_#_ field description.)
productCode is not default or one of the
Authorization Reversal
values related to shipping and/or handling.
(O)
See "Numbered Elements," page 242.
Capture (See the field
description.)
Credit (O)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 326
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
item_#_taxAmount Total tax to apply to the product. This value Authorization (O) String (15)
cannot be negative. The tax amount and the
Capture (O)
unit price must be in the same currency.
Credit (O)
The tax amount field is additive. The following
example uses a two-exponent currency such as
USD:
1 You include the following items in your
request:
item_0_unitPrice=10.00
item_0_quantity=1
item_0_taxAmount=0.80
item_1_unitPrice=20.00
item_1_quantity=1
item_1_taxAmount=1.60
2 The total amount authorized will be 32.40,
not 30.00 with 2.40 of tax included.
If you want to include the tax amount and also
request the taxService service, see Tax
Calculation Service Using the Simple Order
API.

This field is frequently used for Level II and

Level III transactions. See Level II and Level III
Processing Using the Simple Order API.
See "Numbered Elements," page 242.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 327
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
item_#_unitPrice Per-item price of the product. This value cannot Authorization3 String (15)
be negative. You can include a decimal point
Authorization Reversal3
(.), but you cannot include any other special
characters. CyberSource truncates the amount Capture3
to the correct number of decimal places. Credit3
See "Numbered Elements," page 242.
Important Some processors have specific
requirements and limitations, such as maximum
amounts and maximum field lengths. This
information is covered in:
 Merchant Descriptors Using the Simple
Order API
 Table 20, "Capture Information for Specific
Processors," on page 64
 Table 24, "Credit Information for Specific
Processors," on page 82
DCC with a Third-Party Provider
Set this field to the converted amount that was
returned by the DCC provider. You must include
either this field or purchaseTotals_
grandTotalAmount in your request. For
details, see "Dynamic Currency Conversion
with a Third Party Provider," page 133.
FDMS South
If you accept IDR or CLP currencies, see the
entry for FDMS South in Merchant Descriptors
Using the Simple Order API.
Zero Amount Authorizations
If your processor supports zero amount
authorizations, you can set this field to 0 for the
authorization to check if the card is lost or
stolen. See "Zero Amount Authorizations,"
page 231.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 328
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
jpo_ Business name in alphanumeric characters. Authorization (O) String (25)
businessNameAlphanumeric
This field is supported only on JCN Gateway Capture (O on JCN
and for the Sumitomo Mitsui Card Co. acquirer Gateway; not used on
on CyberSource through VisaNet. CyberSource through
VisaNet)
Credit (O on JCN
Gateway; not used on
CyberSource through
VisaNet)
jpo_ Business name in Japanese characters. Authorization (O) String (25)
businessNameJapanese
This field is supported only on JCN Gateway Capture (O on JCN
and for the Sumitomo Mitsui Card Co. acquirer Gateway; not used on
on CyberSource through VisaNet. CyberSource through
VisaNet)
Credit (O on JCN
Gateway; not used on
CyberSource through
VisaNet)
jpo_businessNameKatakana Business name in Katakana characters. Authorization (O) String (25)
This field is supported only on JCN Gateway Capture (O on JCN
and for the Sumitomo Mitsui Card Co. acquirer Gateway; not used on
on CyberSource through VisaNet. CyberSource through
VisaNet)
Credit (O on JCN
Gateway; not used on
CyberSource through
VisaNet)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 329
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
jpo_firstBillingMonth First billing month for a transaction that uses Authorization (O when Integer (2)
installment payments. Possible values: 01 jpo_paymentMethod is
through 12. 4 or 6; otherwise, not
used.)
When you do not include this field in a request
that uses installment payments for one of the
Japanese payment options, CyberSource sets
the first billing month to the calendar month that
follows the transaction date. See "Japanese
Payment Options," page 162.
This field is supported only on JCN Gateway
and for the Sumitomo Mitsui Card Co. acquirer
on CyberSource through VisaNet.
jpo_installments Japanese payment option installments: Number Authorization (R when Integer (2)
of installment payments. See "Japanese jpo_paymentMethod is
Payment Options," page 162. 4 or 6; otherwise, not
used.)
This field is supported only on JCN Gateway
and for the Sumitomo Mitsui Card Co. acquirer Capture (R on JCN
on CyberSource through VisaNet. Gateway when jpo_
paymentMethod is 4 or
6; otherwise, not used.)
Credit (R on JCN
Gateway when jpo_
paymentMethod is 4 or
6; otherwise, not used.)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 330
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
jpo_paymentMethod Japanese payment option payment method: Authorization (O) Integer (1)
type of payment option. Possible values:
Capture (O on JCN
 1 (default): Single payment Gateway; not used on
CyberSource through
 2: Bonus payment
VisaNet)
 4: Installment payment
Credit (O on JCN
 5: Revolving payment Gateway; not used on
 6: Combination of bonus payment and CyberSource through
installment payment VisaNet)

See "Japanese Payment Options," page 162.

This field is supported only on JCN Gateway
and for the Sumitomo Mitsui Card Co. acquirer
on CyberSource through VisaNet.
linkToRequest Value that links the current authorization Authorization (O) String (26)
request to the original authorization request.
Set this value to the request ID that was
returned in the reply message from the original
authorization request.
This value is used for:
 Partial authorizations: see "Partial
Authorizations," page 105.
 Split shipments: see "Split Shipments,"
page 220.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 331
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
loan_assetType Indicates whether a loan is for a recoverable Authorization (R when String (1)
item or a non-recoverable item. Possible using a Visa card issued
values: by BNDES)
 N: non-recoverable item Capture (R when using a
Visa card issued by
 R: recoverable item
BNDES)
This field is supported only for BNDES
Credit (R when using a
transactions on CyberSource through VisaNet.
Visa card issued by
See "BNDES," page 129.
BNDES)
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR2
 Position: 26
 Field: Asset Indicator
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 332
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
loan_type Type of loan based on an agreement between Authorization (R for String (20)
you and the issuer. Examples: AGRO- BNDES transactions on
CUSTEIO, AGRO-INVEST, BNDES-Type1, CyberSource through
CBN, FINAME. VisaNet and installment
payments with
This field is supported only for these kinds of
Mastercard on
payments:
CyberSource through
 BNDES transactions on CyberSource VisaNet in Brazil)
through VisaNet. See "BNDES," page 129.
Capture (R for BNDES
 Installment payments with Mastercard on transactions on
CyberSource through VisaNet in Brazil. See CyberSource through
"Installment Payments on CyberSource VisaNet and installment
through VisaNet," page 150. payments with
For BNDES transactions, the value for this field Mastercard on
corresponds to the following data in the TC 33 CyberSource through
capture file5: VisaNet in Brazil)

 Record: CP07 TCR2

 Position: 27-46
 Field: Loan Type
For installment payments with Mastercard in
Brazil, the value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR4
 Position: 5-24
 Field: Financing Type
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 333
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
merchantCategoryCode Four-digit number that the payment card Authorization, Capture, Integer (4)
industry uses to classify merchants into market Credit:
segments. A payment card company assigned
 American Express
one or more of these values to your business
Direct: R for all
when you started accepting the payment card
aggregator
company’s cards.
transactions.
When you do not include this field in your
 CyberSource through
request, CyberSource uses the value in your
VisaNet: O for all
CyberSource account.
aggregator
See "Aggregator Support," page 117. transactions.
CyberSource through VisaNet  FDC Compass: O for
The value for this field corresponds to the all aggregator
following data in the TC 33 capture file5: authorizations;
otherwise, not used.
 Record: CP01 TCR4
 FDC Nashville Global:
 Position: 150-153
R for all aggregator
 Field: Merchant Category Code transactions.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 334
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
merchantCategoryCode Merchant category code for domestic Authorization (O) Integer (4)
Domestic transactions. The value for this field is a four-
digit number that the payment card industry
uses to classify merchants into market
segments. A payment card company assigned
one or more of these values to your business
when you started accepting the payment card
company’s cards. Including this field in a
request for a domestic transaction might reduce
interchange fees.
When you include this field in a request:
 Do not include the merchantCategoryCode
field.
 The value for this field overrides the value in
your CyberSource account.
This field is supported only for:
 Domestic transactions with Mastercard in
Spain. Domestic means that you and the
customer are in the same country.
 Merchants enrolled in the OmniPay Direct
interchange program.
 First Data Merchant Solutions (Europe) on
OmniPay Direct.
merchantDefinedData_field1 Fields that you can use to store information. Authorization (O) String (255)
to merchantDefinedData_
Important These fields have been replaced Capture (O)
field20
by merchantDefinedData_mddField_1 to 100.
Credit (O)
CyberSource recommends that you update
your order management system to use the new
fields.
Warning Merchant-defined fields must not be
used to capture personally identifying
information as stated in the warning under the
following field description for
merchantDefinedData_mddField_1 to 100.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 335
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
merchantDefinedData_ Fields that you can use to store information. Authorization (O) Installment
mddField_1 to payments
Important These fields override the old Capture (O)
merchantDefinedData_ with
merchant-defined data fields. For example, if
mddField_100 Credit (O) Mastercard
you use the obsolete field
on
merchantDefinedData_field15 and the new
CyberSource
field merchantDefinedData_mddField_15 in
through
the same request, the value for the new field
VisaNet in
overwrites the value for the obsolete field.
Brazil:
Warning Merchant-defined data fields are not String (20)
intended to and must not be used to capture
All other
personally identifying information. Accordingly,
transactions:
merchants are prohibited from capturing,
String (255)
obtaining, and/or transmitting any personally
identifying information in or via the merchant-
defined data fields. Personally identifying
information includes, but is not limited to,
address, payment card number, social security
number, driver's license number, state-issued
identification number, passport number, and
card verification numbers (CVV, CVC2, CVV2,
CID, CVN). In the event CyberSource discovers
that a merchant is capturing and/or transmitting
personally identifying information via the
merchant-defined data fields, whether or not
intentionally, CyberSource will immediately
suspend the merchant's account, which will
result in a rejection of any and all transaction
requests submitted by the merchant after the
point of suspension.
(continued on next page)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 336
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
merchantDefinedData_ CyberSource through VisaNet
mddField_1 to For installment payments with Mastercard in
merchantDefinedData_ Brazil, use merchantDefinedData_mddField_
mddField_100 1 and merchantDefinedData_mddField_2 for
(continued) data that you want to provide to the issuer to
identify the transaction.
See "Installment Payments on CyberSource
through VisaNet," page 150.
For installment payments with Mastercard in
Brazil:
 The value for merchantDefinedData_
mddField_1 corresponds to the following
data in the TC 33 capture file5:
 Record: CP07 TCR5
 Position: 25-44
 Field: Reference Field 2
 The value for merchantDefinedData_
mddField_2 corresponds to the following
data in the TC 33 capture file5:
 Record: CP07 TCR5
 Position: 45-64
 Field: Reference Field 3
merchantID Your CyberSource merchant ID. Use the same Required for all String (30)
merchant ID for evaluation, testing, and CyberSource services.
production.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 337
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
merchantReferenceCode Merchant-generated order reference or tracking Required for all Asia, Middle
number. CyberSource recommends that you CyberSource services. East, and
send a unique value for each transaction so Africa
that you can perform meaningful searches for Gateway:
the transaction. For information about tracking String (40)
orders, see Getting Started with CyberSource
Atos:
Advanced for the Simple Order API.
String (32)
FDC Nashville Global
Elavon
Certain circumstances can cause the processor
Americas:
to truncate this value to 15 or 17 characters for
String (39)
Level II and Level III processing, which can
cause a discrepancy between the value you RuPay:
submit and the value included in some  Credits:
processor reports. String (24)
 Other
services:
String (50)
All other
processors:
String (50)
merchantTransaction Identifier that you assign to the transaction. See Authorization (O) String (30)
Identifier "Merchant-Initiated Reversals and Voids,"
Authorization Reversal
page 170.
(O)
Capture (O)
Credit (O)
Void (O)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 338
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
nationalNetDomesticData Supplementary domestic transaction Authorization (O) String (123)
information provided by the acquirer for
Authorization Reversal
National Net Settlement Service (NNSS)
(O)
transactions. NNSS is a settlement service that
Visa provides. For transactions on Capture (O)
CyberSource through VisaNet in countries that Credit (O)
subscribe to NNSS:
 VisaNet clears transactions; VisaNet
transfers funds to the acquirer after
deducting processing fees and interchange
fees.
 VisaNet settles transactions in the local
pricing currency through a local financial
institution.
This field is supported only on CyberSource
through VisaNet for domestic data in Colombia.
orderRequestToken The request token value returned from a Authorization Reversal String (256)
previous request. This value links the previous (O)
request to the current follow-on request. This
Capture (R for Atos;
field is an encoded string that does not contain
otherwise, O. When you
any confidential information, such as account
request the authorization
numbers or card verification numbers. The
and capture together, the
string can contain a maximum of 256
capture does not require
characters.
a request token.)
Credit (R for Atos;
otherwise, O.)
Void (O)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 339
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
paymentSolution Type of payment solution that is being used for Authorization (See Masterpass:
the transaction. Possible Values: description.) String (3)
 005: Masterpass. This value is required for Authorization Reversal4 Visa
Masterpass transactions on OmniPay Direct. Checkout and
Capture4
See "Masterpass," page 169. Visa Secure
Credit4 Remote
 visacheckout: Visa Checkout or Visa
Commerce:
Secure Remote Commerce. This value is
String (12)
required for Visa Checkout and Visa Secure
Remote Commerce transactions. See the
Visa Checkout and Visa Secure Remote
Commerce web page.
personalID_number Identifier for the customer. This field is Authorization (O) String (18)
supported only on the processors listed in this
description.
Cielo 3.0
Set this field to the Cadastro Nacional da
Pessoa Jurídica (CNPJ) or Cadastro de
Pessoas Fisicas (CPF).
Comercio Latino
Set this field to the Cadastro de Pessoas
Fisicas (CPF).
personalID_type Type of value in the personalID_number field. Authorization (R if String (7)
Possible values: personalID_number is
included; otherwise, not
 BR_CNPJ: Cadastro Nacional da Pessoa
used.)
Jurídica (CNPJ)
 BR_CPF: Cadastro de Pessoas Fisicas
(CPF)
This field is supported only on Cielo 3.0.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 340
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
pos_environment Operating environment. Authorization (O) String (1)
Possible values for all card types except
Mastercard:
 0: No terminal used or unknown
environment.
 1: On merchant premises, attended.
 2: On merchant premises, unattended.
Examples: oil, kiosks, self-checkout, mobile
telephone, personal digital assistant (PDA).
 3: Off merchant premises, attended.
Examples: portable POS devices at trade
shows, at service calls, or in taxis.
 4: Off merchant premises, unattended.
Examples: vending machines, home
computer, mobile telephone, PDA.
 5: On premises of customer, unattended.
 9: Unknown delivery mode.
 S: Electronic delivery of product. Examples:
music, software, or eTickets that are
downloaded over the internet.
 T: Physical delivery of product. Examples:
music or software that is delivered by mail or
by a courier.
(continued on next page)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 341
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
pos_environment Possible values for Mastercard:
(continued)
 2: On merchant premises, unattended, or
customer terminal. Examples: oil, kiosks,
self-checkout, home computer, mobile
telephone, personal digital assistant (PDA).
Customer terminal is supported only for
Mastercard transactions on CyberSource
through VisaNet.
 4: Off merchant premises, unattended, or
customer terminal. Examples: vending
machines, home computer, mobile
telephone, PDA. Customer terminal is
supported only for Mastercard transactions
on CyberSource through VisaNet.
This field is supported only on American
Express Direct and CyberSource through
VisaNet.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 342
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
postdatedTransaction_ Amount that is guaranteed for the post-dated Authorization (R for post- String (8)
guaranteeAmount transaction. The amount is specified in an dated transactions with
agreement between you and the issuer. Mastercard)
Format: 8 digits including 2 minor units, BRL
currency only.
A post-dated transaction enables a customer to
make a purchase using a debit Mastercard and
to have the debit post to the customer's account
at a later date.
This field is supported only for post-dated
transactions with Mastercard in Brazil on
CyberSource through VisaNet.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 5-12
 Field: Mastercard Post-Dated Transaction
Details
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 343
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
postdatedTransaction_ Indicates whether the post-dated transaction Authorization (R for post- String (5)
guaranteeIndicator has a guarantee defined by an agreement dated transactions with
between you and the issuer. The customer tells Mastercard)
you whether they would like the transaction to
be post-dated. The issuer provides the
guarantee.
Possible values:
 true: The post-dated transaction has a
guarantee.
 false: The post-dated transaction does not
have a guarantee.
A post-dated transaction enables a customer to
make a purchase using a debit Mastercard and
to have the debit post to the customer's account
at a later date.
This field is supported only for post-dated
transactions with Mastercard in Brazil on
CyberSource through VisaNet.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 55
 Field: Mastercard Post-Dated Transaction
Details
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 344
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
postdatedTransaction_ Date you plan to send a capture request to Authorization (R for post- String (8)
settlementDate CyberSource for the post-dated transaction. A dated transactions with
post-dated transaction enables a customer to Mastercard)
make a purchase using a debit Mastercard and
to have the debit post to the customer's account
at a later date.
Format: YYYYMMDD
This field is supported only for post-dated
transactions with Mastercard in Brazil on
CyberSource through VisaNet.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP07 TCR0
 Position: 13-18
 Field: Mastercard Post-Dated Transaction
Details
processorID Value that identifies the acquirer to use for the Authorization (O) String (3)
transaction. This value is supported only on
Credit (O for stand-alone
CyberSource through VisaNet. Contact
credits; otherwise, not
CyberSource Customer Support to get the
used.)
value for this field.
purchaseTotals_ Additional amount. This field is supported only Capture (O) String (12)
additionalAmount0 on American Express Direct. See "Additional
Credit (O)
Amounts," page 116.
purchaseTotals_
additionalAmount1
purchaseTotals_
additionalAmount2
purchaseTotals_
additionalAmount3
purchaseTotals_
additionalAmount4
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 345
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
purchaseTotals_ Additional amount type. This field is supported Capture (O) String (3)
additionalAmountType0 only on American Express Direct. See
Credit (O)
"Additional Amounts," page 116, for a
purchaseTotals_
description of this feature. For the possible
additionalAmountType1
values for this field, see Appendix C,
purchaseTotals_ "Additional Amount Types," on page 462.
additionalAmountType2
purchaseTotals_
additionalAmountType3
purchaseTotals_
additionalAmountType4
purchaseTotals_currency Currency used for the order. Use the three- Authorization (R) String (5)
character ISO Standard Currency Codes.
Authorization Reversal
For the authorization reversal and capture (R)
services, you must use the same currency that
Capture (R)
you used in your request for the authorization
service. Credit (R)

DCC with a Third-Party Provider Incremental

Your customer’s billing currency. For details, Authorization (R)
see "Dynamic Currency Conversion with a
Third Party Provider," page 133.
purchaseTotals_ Exchange rate returned by the DCC provider. Authorization (R for DCC String (16)
exchangeRate Includes a decimal point and a maximum of 4 transactions)
decimal places. For details, see "Dynamic
Currency Conversion with a Third Party
Provider," page 133.
purchaseTotals_ Time stamp for the exchange rate. This value is Authorization (O) String (14)
exchangeRateTimeStamp returned by the DCC provider. This value must
be in GMT.
Format: YYYYMMDDhhmmss
For details, see "Dynamic Currency Conversion
with a Third Party Provider," page 133.
purchaseTotals_ Set this field to the converted amount that was Authorization (O) String (15)
foreignAmount returned by the DCC provider. See "Dynamic
Currency Conversion with a Third Party
Provider," page 133.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 346
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
purchaseTotals_ Your customer’s billing currency. See "Dynamic Authorization (O) String (5)
foreignCurrency Currency Conversion with a Third Party
Provider," page 133.
purchaseTotals_ Grand total for the order. This value cannot be Authorization3 Comercio
grandTotalAmount negative. You can include a decimal point (.), Latino:
Authorization Reversal3
but you cannot include any other special String (19)
characters. CyberSource truncates the amount Capture3
All other
to the correct number of decimal places. Credit3 processors:
Important Some processors have specific Incremental String (15)
requirements and limitations, such as maximum Authorization (R)
amounts and maximum field lengths. This
information is covered in:
 Merchant Descriptors Using the Simple
Order API
 Table 20, "Capture Information for Specific
Processors," on page 64
 Table 24, "Credit Information for Specific
Processors," on page 82
If your processor supports zero amount
authorizations, you can set this field to 0 for the
authorization to check if the card is lost or
stolen. See "Zero Amount Authorizations,"
page 231.
DCC with a Third-Party Provider
Set this field to the converted amount that was
returned by the DCC provider. You must include
either this field or item_#_unitPrice in your
request. For details, see "Dynamic Currency
Conversion with a Third Party Provider,"
page 133.
FDMS South
If you accept IDR or CLP currencies, see the
entry for FDMS South in Merchant Descriptors
Using the Simple Order API.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 347
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
purchaseTotals_ Amount in your original local pricing currency. Authorization (R when String (15)
originalAmount This value cannot be negative. You can include DCC is used for the
a decimal point (.) in this field to denote the purchase.)
currency exponent, but you cannot include any
Capture (R when DCC is
other special characters. If needed,
used for the purchase.)
CyberSource truncates the amount to the
correct number of decimal places. For details, Credit (R when DCC is
see "Dynamic Currency Conversion with a used for the purchase.)
Third Party Provider," page 133.
purchaseTotals_ Your local pricing currency code. For the Authorization (R for DCC String (5)
originalCurrency possible values, see the ISO Standard transactions)
Currency Codes. For details, see "Dynamic
Currency Conversion with a Third Party
Provider," page 133.
recipient_accountID Identifier for the recipient’s account. Use the Authorization (R in String with
first six digits and last four digits of the recipient transactions; numbers only
recipient’s account number. otherwise, not used.) (10)
This field is a pass-through, which means that
CyberSource does not verify the value or
modify it in any way before sending it to the
processor. If the field is not required for the
transaction, CyberSource does not forward it to
the processor. See "Recipients," page 206.
recipient_dateOfBirth Recipient’s date of birth. This field is a pass- Authorization (R in String with
through, which means that CyberSource recipient transactions; numbers only
ensures that the value is eight numeric otherwise, not used.) (8)
characters but otherwise does not verify the
value or modify it in any way before sending it
to the processor. If the field is not required for
the transaction, CyberSource does not forward
it to the processor. See "Recipients," page 206.
Format: YYYYMMDD.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 348
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
recipient_lastName Recipient’s last name. This field is a pass- Authorization (R in String with
through, which means that CyberSource does recipient transactions; letters and
not verify the value or modify it in any way otherwise, not used.) numbers only
before sending it to the processor. If the field is (6)
not required for the transaction, CyberSource
does not forward it to the processor. See
"Recipients," page 206.
recipient_postalCode Partial postal code for the recipient’s address. Authorization (R in String with
For example, if the postal code is NN5 7SG, the recipient transactions; letters and
value for this field should be the first part of the otherwise, not used.) numbers only
postal code: NN5. (6)
This field is a pass-through, which means that
CyberSource does not verify the value or
modify it in any way before sending it to the
processor. If the field is not required for the
transaction, CyberSource does not forward it to
the processor. See "Recipients," page 206.
recurringSubscriptionInfo When you use Payment Tokenization or Authorization (O) String (26)
_subscriptionID Recurring Billing and you include this value in
Credit (O)
your request, many of the fields that are
normally required for an authorization or credit
become optional. See "Payment Tokenization,"
page 204, and "Recurring Billing," page 207.
reportGroup Attribute that lets you define custom grouping Authorization (O) String (25)
for your processor reports. This field is
Authorization Reversal
supported only on Worldpay VAP. See "Report
(O)
Groups," page 217.
Capture (O)
Credit (O)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 349
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
shipFrom_postalCode Postal code for the address from which the Capture (O) String (10)
goods are shipped, which is used to establish
Credit (O)
nexus. The default is the postal code
associated with your CyberSource account.
The postal code must consist of 5 to 9 digits.
When the billing country is the U.S., the 9-digit
postal code must follow this format:
[5 digits][dash][4 digits]
Example 12345-6789
When the billing country is Canada, the 6-digit
postal code must follow this format:
[alpha][numeric][alpha][space]
[numeric][alpha][numeric]
Example A1B 2C3
This field is frequently used for Level II and
Level III transactions. See Level II and Level III
Processing Using the Simple Order API.
American Express Direct
Before sending the postal code to the
processor, CyberSource removes all non-
alphanumeric characters and, if the remaining
value is longer than nine characters, truncates
the value starting from the right side.
shipTo_buildingNumber Building number in the street address. For Authorization (O) String (15)
example, the building number is 187 in the
following address:
Rua da Quitanda 187

shipTo_city City of the shipping address. Authorization (R when String (50)

any shipping address
information is included in
the request and shipping
to the U.S. or Canada;
otherwise, O.)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 350
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
shipTo_country Country of the shipping address. Use the two- Authorization (R when String (2)
character ISO Standard Country Codes. any shipping address
information is included in
the request; otherwise,
O.)
Capture (R when any
shipping address
information is included in
the request; otherwise,
O.)
Credit (R when any
shipping address
information is included in
the request; otherwise,
O.)
shipTo_district Neighborhood, community, or region within a Authorization (O) String (50)
city or municipality.

shipTo_firstName First name of the recipient. Authorization (O) Worldpay

VAP:
String (25)
All other
processors:
String (60)
shipTo_lastName Last name of the recipient. Authorization (O) Worldpay
VAP:
String (25)
All other
processors:
String (60)
shipTo_phoneNumber Phone number for the shipping address. Authorization (O) String (15)

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 351
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
shipTo_postalCode Postal code for the shipping address. The Authorization (R when String (10)
postal code must consist of 5 to 9 digits. any shipping address
information is included in
When the shipping country is the U.S., the 9-
the request and shipping
digit postal code must follow this format:
to the U.S. or Canada;
[5 digits][dash][4 digits]
otherwise, O.)
Example 12345-6789
Capture (R when any
When the shipping country is Canada, the 6- shipping address
digit postal code must follow this format: information is included in
[alpha][numeric][alpha][space] the request and shipping
[numeric][alpha][numeric] to the U.S. or Canada;
Example A1B 2C3 otherwise, O.)
Credit (R when any
shipping address
American Express Direct
information is included in
Before sending the postal code to the
the request and shipping
processor, CyberSource removes all non-
to the U.S. or Canada;
alphanumeric characters and, if the remaining
otherwise, O.)
value is longer than nine characters, truncates
the value starting from the right side.
shipTo_shippingMethod Shipping method for the product. Possible Authorization (O) String (10)
values:
 lowcost: Lowest-cost service
 sameday: Courier or same-day service
 oneday: Next-day or overnight service
 twoday: Two-day service
 threeday: Three-day service
 pickup: Store pick-up
 other: Other shipping method
 none: No shipping method because
product is a service or subscription

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 352
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
shipTo_state State or province of the shipping address. Use Authorization (R when String (2)
the State, Province, and Territory Codes for the any shipping address
United States and Canada. information is included in
the request and shipping
to the U.S. or Canada;
otherwise, O.)
shipTo_street1 First line of the shipping address. Authorization (R when Worldpay
any shipping address VAP:
information is included in String (35)
the request; otherwise,
All other
O.)
processors:
String (60)
shipTo_street2 Second line of the shipping address. Authorization (O) Worldpay
VAP:
String (35)
All other
processors:
String (60)
subsequentAuth Indicates whether the transaction is a Authorization: String (5)
merchant-initiated transaction. Possible values:
 R for merchant-
 true: Merchant-initiated transaction initiated transactions.
 false: Not a merchant-initiated transaction  R for subsequent
authorizations on
This field is supported for:
FDC Nashville Global
 All merchant-initiated transactions. See and Streamline.
"Merchant-Initiated Transactions (MITs) and
 Otherwise, not used.
Credentials-on-File (COF) Transactions,"
page 173.
 Subsequent authorizations on FDC Nashville
Global and Streamline. For information about
subsequent authorizations, see Payment
Network Tokenization Using the Simple
Order API.
CyberSource through VisaNet
The value for this field does not correspond to
any data in the TC 33 capture file.5
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 353
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
subsequentAuthFirst Indicates whether the transaction is the first Authorization (R for String (5)
merchant-initiated transaction in a series, which merchant-initiated
means that the customer initiated the previous transactions; otherwise,
transaction. Possible values: not used.)
 true: First merchant-initiated transaction
 false: Not the first merchant-initiated
transaction
This field is supported only for merchant-
initiated transactions. See "Merchant-Initiated
Transactions (MITs) and Credentials-on-File
(COF) Transactions," page 173.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR1
 Position: 136
 Field: POS Environment
subsequentAuthOriginal Amount of the original authorization. This field Authorization (See String (60)
Amount is supported only for the following kinds of description.)
transactions with Discover:
 Merchant-initiated transactions. See
"Merchant-Initiated Transactions (MITs) and
Credentials-on-File (COF) Transactions,"
page 173.
 Recurring payments on FDC Nashville
Global that use Payment Network
Tokenization. See Payment Network
Tokenization Using the Simple Order API.
 Subsequent authorizations on FDC Nashville
Global and Streamline. For information about
subsequent authorizations, see Payment
Network Tokenization Using the Simple
Order API.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 354
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
subsequentAuthReason Reason for the merchant-initiated transaction or Authorization (See String (1)
incremental authorization. Possible values: description)
 1: Resubmission Incremental
Authorization (R)
 2: Delayed charge
 3: Reauthorization for split shipment
 4: No show
 5: Incremental authorization
This field is supported only for:
 The five kinds of merchant-initiated
transactions in the preceding list. See
"Merchant-Initiated Transactions (MITs) and
Credentials-on-File (COF) Transactions,"
page 173.
 Incremental authorizations. See "Incremental
Authorizations," page 45.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR0
 Position: 160-163
 Field: Message Reason Code
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 355
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
subsequentAuthStored Indicates whether you obtained the payment Authorization (R for String (5)
Credential information from credentials on file (COF) transactions that use
instead of from the customer. Possible values: COF information;
otherwise, not used.)
 true: Transaction uses COF
 false: Transaction does not use COF
When you use the Token Management Service,
CyberSource sets this field to true for you.
For information about the Token Management
Service, see Token Management Service Using
the Simple Order API.
For information about merchant-initiated
transactions, see "Merchant-Initiated
Transactions (MITs) and Credentials-on-File
(COF) Transactions," page 173.
subsequentAuthTransaction Network transaction identifier that was returned Authorization: String (15)
ID in the ccAuthReply_
 R for installment
paymentNetworkTransactionID field in the
payments on FDI
reply message for either the original
Australia.
authorization in the series or the previous
authorization in the series.  R for merchant-
initiated transactions.
CyberSource through VisaNet
The value for this field does not correspond to  Otherwise, not used.
any data in the TC 33 capture file.5
FDI Australia
See "Installment Payments on FDI Australia,"
page 159.
All Processors Other Than FDI Australia
See "Merchant-Initiated Transactions (MITs)
and Credentials-on-File (COF) Transactions,"
page 173.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 356
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
surchargeAmount The surcharge amount is included in the total Authorization (O) String (15)
transaction amount but is passed in a separate
field to the issuer and acquirer for tracking. The
issuer can provide information about the
surcharge amount to the customer. This field is
supported only on CyberSource through
VisaNet.
surchargeSign Sign for the surcharge amount. Possible Authorization (O) String (1)
values:
 C: The surcharge amount will be credited to
the customer’s account.
 D: The surcharge amount will be debited
from the customer’s account.
This field is supported only on CyberSource
through VisaNet.
thirdPartyCertification Value that identifies the application vendor and Authorization (O) String (12)
Number application version for a third party gateway.
Authorization Reversal
CyberSource provides you with this value
(O)
during testing and validation.
Capture (O)
This field is supported only on CyberSource
through VisaNet. Credit (O)
Incremental
Authorization (O)
Void (O)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 357
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
transactionLocalDateTime Local date and time at your physical location. Authorization (O) String (14)
Include both the date and time in this field or
leave it blank. This field is supported only on
CyberSource through VisaNet.
Format: YYYYMMDDhhmmss
where:
 YYYY = year
 MM = month
 DD = day
 hh = hour
 mm = minutes
 ss = seconds
ucaf_authenticationData Universal cardholder authentication field Authorization String (32)
(UCAF) data. For the description and
requirements, see "Payer Authentication,"
page 186.
ucaf_collectionIndicator Universal cardholder authentication field Authorization String with
(UCAF) collection indicator. For the description numbers only
and requirements, see "Payer Authentication," (1)
page 186.
CyberSource through VisaNet
The value for this field corresponds to the
following data in the TC 33 capture file5:
 Record: CP01 TCR7
 Position: 5
 Field: Mastercard Electronic Commerce
Indicators—UCAF Collection Indicator
vc_orderID Identifier for the Visa Checkout or Visa Secure Authorization4 String (48)
Remote Commerce order. Visa Checkout and 4
Authorization Reversal
Visa Secure Remote Commerce provide a
unique order ID for every transaction in the Visa Capture4
Checkout and Visa Secure Remote Commerce Credit4
callID field. See the Visa Checkout and Visa
Secure Remote Commerce web page.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 358
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
voidService_run Whether to include the void service in your Void (R) String (5)
request. Possible values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
For information about this service, see "Voiding
a Capture or Credit," page 85.
voidService_voidRequestID Request ID of the capture or credit you want to Void (R) String (26)
void.
voidService_ Value of the request token returned from a Void (R for Atos; String (256)
voidRequestToken previous request for a service that you want to otherwise, O.)
void.
The field is an encoded string that contains no
confidential information, such as an account
number or card verification number. The string
can contain a maximum of 256 characters.

1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.

2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 359
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
wallet_type Type of wallet. For possible values, see Masterpass (101, 102, String (5)
Appendix U, "Values for the Wallet Type Field," 103, 216, and 217)
on page 506. Authorization (O)
For Visa Checkout and Visa Secure Remote Credit (O on Chase
Commerce transactions, the way CyberSource Paymentech Solutions
processes the value for this field depends on and CyberSource
the processor. See the Visa Checkout and Visa through VisaNet. Not
Secure Remote Commerce section below. used for credits on
OmniPay Direct.)
For all other values, this field is a passthrough;
therefore, CyberSource does not verify the Incremental
value or modify it in any way before sending it Authorization (O for
to the processor. Mastercard on
CyberSource through
For incremental authorizations, this field is VisaNet; otherwise, not
supported only for Mastercard and the used.)
supported values are 101 and 102.
Staged Digital Wallet
Payment card companies can introduce new (SDW)
values without notice. Your order management Authorization (O)
system should be able to process new values
Credit (O)
without problems.
Visa Checkout and
CyberSource through VisaNet
Visa Secure Remote
When the value for this field is 101, 102, 103,
Commerce (VCIND)
216, or 217, it corresponds to the following
Authorization (See
data in the TC 33 capture file5:
description)
 Record: CP01 TCR6 Credit (O for stand-alone
 Position: 88-90 credits. Not used for
follow-on credits.)
 Field: Mastercard Wallet Identifier
When the value for this field is VCIND, it
corresponds to the following data in the TC 33
capture file5:
 Record: CP01 TCR8
 Position: 72-76
 Field: Agent Unique ID
(continued on next page)
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 360
 Appendix A API Fields

Table 55 Request Fields (Continued)

Field Description Used By: Data Type
Required (R) & Length
or Optional (O)
wallet_type Masterpass (101, 102, 103, 216, and 217)
(continued) The Masterpass platform generates the wallet
type value and passes it to you along with the
customer’s checkout information.
Visa Checkout and Visa Secure Remote
Commerce
This field is optional for Visa Checkout and Visa
Secure Remote Commerce authorizations on
FDI Australia. For all other processors, this field
is required for Visa Checkout and Visa Secure
Remote Commerce authorizations.
For Visa Checkout and Visa Secure Remote
Commerce transactions on the following
processors, CyberSource sends the value that
the processor expects for this field:
 FDC Compass
 FDC Nashville Global
 FDI Australia
 TSYS Acquiring Solutions
For all other processors, this field is a
passthrough; therefore, CyberSource does not
verify the value or modify it in any way before
sending it to the processor.
1 Optional for a follow-on credit request, which must include ccCreditService_captureRequestID.
2 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See
"Relaxed Requirements for Address Data and Expiration Date," page 91. Important It is your responsibility to determine whether a
field is required for the transaction you are requesting.
3 You must include either item_#_unitPrice or purchaseTotals_grandTotalAmount in your request. For information about items and
grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.
4 Required for Visa Checkout and Visa Secure Remote Commerce transactions. Otherwise, not used.
5 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information
to facilitate end-of-day clearing processing with payment card companies.

Credit Card Services Using the Simple Order API | September 2019 361
 Appendix A API Fields

Reply Fields
Table 56 Reply Fields

Field Description Returned By Data Type

& Length
additionalData This field might contain information about a Authorization String (255)
decline. This field is supported only on
Incremental
CyberSource through VisaNet.
Authorization
additionalProcessor Processor-defined response category code. The Authorization Comercio
Response associated detail error code is in the Latino:
Authorization
ccAuthReply_processorResponse field or the Integer (32)
Reversal
ccAuthReversalReply_processorResponse
All other
field depending on which service you requested.
processors:
This field is supported only for: Integer (3)
 Japanese issuers
 Domestic transactions in Japan
 Comercio Latino—processor transaction ID
required for troubleshooting
authIndicator Flag indicating the type of authorization that was Authorization String (1)
performed. See "Final Authorization Indicator,"
page 138. This field is not returned for unmarked
authorizations. Possible values for all processors
except CyberSource through VisaNet:
 0: Preauthorization
 1: Final authorization
Some processors that support the final
authorization indicator do not return this field. For
a list of the processors that support this field, see
the procedure at the end of "Final Authorization
Indicator," page 138.
CyberSource through VisaNet
Possible value for Visa transactions:
 0: Authorization for an estimated amount
Possible values for Mastercard transactions:
 0: Preauthorization
 1: Final authorization
 2: Undefined authorization
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 362
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
card_prepaidReloadable Indicates whether the prepaid card is reloadable. Authorization String (7)
This field is supported only on Worldpay VAP. See
"Card Type Indicators (CTIs)," page 130.
Possible values:
 Yes
 No
 Unknown
card_prepaidType Type of prepaid card, such as: Authorization String (50)
 GIFT
 PAYROLL
 GENERAL_PREPAID
This field is supported only on Worldpay VAP. See
"Card Type Indicators (CTIs)," page 130.
card_virtual Indicates whether the card number corresponds to Authorization String (5)
a virtual card number. This field is supported only
on Worldpay VAP. See "Card Type Indicators
(CTIs)," page 130.
Possible values:
 true
 false
ccAuthReply_ Remaining balance on the account. See "Balance Authorization String (12)
accountBalance Responses," page 111, and "Balance Inquiries,"
page 128.
ccAuthReply_ Currency of the remaining balance on the account. Authorization String (5)
accountBalanceCurrency For the possible values, see the ISO Standard
Currency Codes. Also see "Balance Responses,"
page 111, and "Balance Inquiries," page 128.
ccAuthReply_ Sign for the remaining balance on the account. Authorization String (8)
accountBalanceSign Returned only when the processor returns this
value. See "Balance Inquiries," page 128.
Possible values:
 positive
 negative
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 363
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Type of account. This value is returned only when Authorization String (2)
accountType you request a balance inquiry. See "Balance
Inquiries," page 128.
Possible values:
 00: Not applicable or not specified
 10: Savings account
 20: Checking account
 30: Credit card account
 40: Universal account
ccAuthReply_ Chase Paymentech Solutions Authorization Chase
affluenceIndicator Indicates whether a customer has high credit Paymentech
limits. This information enables you to market high Solution:
cost items to these customers and to understand String (1)
the kinds of cards that high income customers are
Worldpay
using.
VAP:
This field is supported for Visa, Mastercard, String (13)
Discover, and Diners Club.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
Worldpay VAP
Flag indicating that a Visa customer or Mastercard
customer is in one of the affluent categories.
Possible values:
 AFFLUENT: High income customer with high
spending pattern (>100k USD annual income
and >40k USD annual card usage).
 MASS AFFLUENT: High income customer
(>100k USD annual income).
ccAuthReply_amount Amount that was authorized. Authorization String (15)
FDMS South
If you accept IDR or CLP currencies on FDMS
South, see the entry for FDMS South in Merchant
Descriptors Using the Simple Order API.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 364
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Type of amount. This value is returned only when Authorization String (2)
amountType you request a balance inquiry. The issuer
determines the value that is returned. See
"Balance Inquiries," page 128.
Possible values for deposit accounts:
 01: Current ledger (posted) balance.
 02: Current available balance, which is typically
the ledger balance less outstanding
authorizations. Some depository institutions
also include pending deposits and the credit or
overdraft line associated with the account.

Possible values for credit card accounts:

 01: Credit amount remaining for customer
(open to buy).
 02: Credit limit.
ccAuthReply_ Authorization code. Returned only when the Authorization String
authorizationCode processor returns this value.
The length of
Elavon Encrypted Account Number Program this value
The returned value is OFFLINE. See "Encoded depends on
Account Numbers," page 137. your
processor.
TSYS Acquiring Solutions
The returned value for a successful zero amount
authorization is 000000. See "Zero Amount
Authorizations," page 231.
ccAuthReply_ Time of authorization. Authorization Date and
authorizedDateTime time (20)
ccAuthReply_avsCode AVS results. See "Address Verification System Authorization String (1)
(AVS)," page 88, for a description of AVS. See
Appendix E, "AVS Codes," on page 468, for the list
of AVS codes.
ccAuthReply_ AVS result code sent directly from the processor. Authorization String (10)
avsCodeRaw Returned only when the processor returns this
value.
Important Do not use this field to evaluate the
result of AVS. Use for debugging purposes only.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 365
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ CyberSource through VisaNet Authorization CyberSource
cardCategory Visa product ID. For descriptions of the Visa through
product IDs, see the Product ID table on the Visa VisaNet:
Request & Response Codes web page at https:// String (3)
developer.visa.com/guides/request_response_
GPN:
codes.
String (3)
GPN
RBS
Visa or Mastercard product ID. For descriptions of
WorldPay
the Visa product IDs, see the Product ID table on
Atlanta:
the Visa Request & Response Codes web page at
String (1)
https://developer.visa.com/guides/request_
response_codes. For descriptions of the Worldpay
Mastercard product IDs, see Appendix S, "Product VAP:
IDs," on page 501. String (7)

Worldpay VAP
Important Before using this field on Worldpay
VAP, you must contact CyberSource Customer
Support to have your account configured for this
feature.
Type of card used in the transaction. The only
possible value is:
 PREPAID: Prepaid Card
RBS WorldPay Atlanta
Type of card used in the transaction. Possible
values:
 B: Business Card
 O: Noncommercial Card
 R: Corporate Card
 S: Purchase Card
 Blank: Purchase card not supported
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 366
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Indicates whether the card is a commercial card, Authorization String (1)
cardCommercial which enables you to include Level II data in your
transaction requests.
This field is supported for Visa and Mastercard on
Chase Paymentech Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
ccAuthReply_cardGroup Type of commercial card. This field is supported Authorization String (1)
only on CyberSource through VisaNet. Possible
values:
 B: Business card
 R: Corporate card
 S: Purchasing card
 0: Noncommercial card
ccAuthReply_ Indicates whether the card is a healthcare card. Authorization String (1)
cardHealthcare
This field is supported for Visa and Mastercard on
Chase Paymentech Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
ccAuthReply_ Country in which the card was issued. This Authorization String (3)
cardIssuerCountry information enables you to determine whether the
card was issued domestically or internationally.
Use the two-character ISO Standard Country
Codes.
This field is supported for Visa, Mastercard,
Discover, Diners Club, JCB, and Maestro
(International) on Chase Paymentech Solutions.
See "Card Type Indicators (CTIs)," page 130.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 367
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Indicates whether the card is eligible for Level III Authorization String (1)
cardLevel3Eligible interchange fees, which enables you to include
Level III data in your transaction requests.
This field is supported for Visa and Mastercard on
Chase Paymentech Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
ccAuthReply_cardPayroll Indicates whether the card is a payroll card. Authorization String (1)
This field is supported for Visa, Discover, Diners
Club, and JCB on Chase Paymentech Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
ccAuthReply_ Indicates whether the card is a PINless debit card. Authorization String (1)
cardPINlessDebit
This field is supported for Visa and Mastercard on
Chase Paymentech Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 368
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Indicates whether the card is a prepaid card. This Authorization String (1)
cardPrepaid information enables you to determine when a gift
card or prepaid card is presented for use when
establishing a new recurring, installment, or
deferred billing relationship.
This field is supported for Visa, Mastercard,
Discover, Diners Club, and JCB on Chase
Paymentech Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
ccAuthReply_ Indicates whether the card is regulated according Authorization String (1)
cardRegulated to the Durbin Amendment. If the card is regulated,
the card issuer is subject to price caps and
interchange rules.
This field is supported for Visa, Mastercard,
Discover, Diners Club, and JCB on Chase
Paymentech Solutions.
Possible values:
 Y: Yes (assets greater than 10B USD)
 N: No (assets less than 10B USD)
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 369
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Indicates whether the card is a signature debit Authorization String (1)
cardSignatureDebit card. This information enables you to alter the way
an order is processed. For example, you might not
want to reauthorize a transaction for a signature
debit card, or you might want to perform reversals
promptly for a signature debit card.
This field is supported for Visa, Mastercard, and
Maestro (International) on Chase Paymentech
Solutions.
Possible values:
 Y: Yes
 N: No
 X: Not applicable / Unknown
See "Card Type Indicators (CTIs)," page 130.
ccAuthReply_ Mapped response code for Visa Secure and Authorization String (3)
cavvResponseCode American Express SafeKey:
 See "Visa Secure," page 197, and Appendix T,
"Visa Secure Response Codes," on page 505.
 See "American Express SafeKey," page 187,
and Appendix D, "American Express SafeKey
Response Codes," on page 467.
ccAuthReply_ Raw response code sent directly from the Authorization String (3)
cavvResponseCode processor for Visa Secure and American Express
Raw SafeKey:
 See "Visa Secure," page 197.
 See "American Express SafeKey," page 187.
ccAuthReply_cvCode CVN result code. See "Card Verification Numbers Authorization String (1)
(CVNs)," page 97, for a description of the card
verification check. See Appendix J, "CVN Codes,"
on page 479 for the list of CVN codes.
ccAuthReply_ CVN result code sent directly from the processor. Authorization String (11)
cvCodeRaw Returned only when the processor returns this
value.
Important Do not use this field to evaluate the
result of card verification. Use for debugging
purposes only.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 370
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Fraud score for a Mastercard transaction. For a Authorization String (32)
emsTransactionRisk description of this feature, see "Mastercard Expert
Score Monitoring Solutions (EMS)," page 168.
 Positions 1-3: Fraud score. This value ranges
from 001 to 998, where 001 indicates the
least likely fraudulent transaction and 998
indicates the most likely fraudulent transaction.
 Positions 4-5: Reason code that specifies the
reason for the fraud score. See Appendix L,
"Expert Monitoring Solutions (EMS) Reason
Codes," on page 484.
 Positions 6-32: Reserved for future use.
This field is supported only on CyberSource
through VisaNet.
ccAuthReply_evEmail Mapped Electronic Verification response code for Authorization String (1)
the customer’s email address. See Appendix M,
"Electronic Verification Response Codes," on
page 486.
ccAuthReply_ Raw Electronic Verification response code from Authorization String (1)
evEmailRaw the processor for the customer’s email address.
ccAuthReply_evName Mapped Electronic Verification response code for Authorization String (1)
the customer’s name. See Appendix M,
"Electronic Verification Response Codes," on
page 486.
ccAuthReply_ Raw Electronic Verification response code from Authorization String (1)
evNameRaw the processor for the customer’s last name.
ccAuthReply_ Mapped Electronic Verification response code for Authorization String (1)
evPhoneNumber the customer’s phone number. See Appendix M,
"Electronic Verification Response Codes," on
page 486.
ccAuthReply_ Raw Electronic Verification response code from Authorization String (1)
evPhoneNumberRaw the processor for the customer’s phone number.
ccAuthReply_ Mapped Electronic Verification response code for Authorization String (1)
evPostalCode the customer’s postal code. See Appendix M,
"Electronic Verification Response Codes," on
page 486.
ccAuthReply_ Raw Electronic Verification response code from Authorization String (1)
evPostalCodeRaw the processor for the customer’s postal code.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 371
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_evStreet Mapped Electronic Verification response code for Authorization String (1)
the customer’s street address. See Appendix M,
"Electronic Verification Response Codes," on
page 486.
ccAuthReply_ Raw Electronic Verification response code from Authorization String (1)
evStreetRaw the processor for the customer’s street address.
ccAuthReply_ Name of the Japanese acquirer that processed the Authorization String (32)
forwardCode transaction. Returned only on JCN Gateway.
Contact the CyberSource Japan Support Group
for more information.
ccAuthReply_ Reason the recurring payment transaction was Authorization String (2)
merchantAdviceCode declined. For some processors, this field is used
only for Mastercard. For other processors, this
field is used for Visa and Mastercard. And for other
processors, this field is not implemented. Possible
values:
 00: Response not provided.
 01: New account information is available.
Obtain the new information.
 02: Try again later.
 03: Do not try again. Obtain another type of
payment from the customer.
 04: Problem with a token or a partial shipment
indicator.
 21: Recurring payment cancellation service.
 99: An unknown value was returned from the
processor.
ccAuthReply_ Raw merchant advice code sent directly from the Authorization String (2)
merchantAdviceCode processor. This field is used only for Mastercard.
Raw
CyberSource through VisaNet
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR7
 Position: 96-99
 Field: Response Data—Merchant Advice Code
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 372
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Merchant ID that was used to create the Authorization String (30)
ownerMerchantID subscription or customer profile for which the
service was requested.
Payment Tokenization
When your account is enabled for Payment
Tokenization, this field is returned only when you
use profile sharing and when your merchant ID is
in the same merchant ID pool as the owner
merchant ID. See the profile sharing information in
Payment Tokenization Using the Simple Order
API.
Recurring Billing
When your account is enabled for Recurring
Billing, this field is returned only when you use
subscription sharing and when your merchant ID is
in the same merchant ID pool as the owner
merchant ID. See the subscription sharing
information in Recurring Billing Using the Simple
Order API.
ccAuthReply_ Network transaction identifier (TID). You can use Authorization Comercio
paymentNetwork this value to identify a specific transaction when Latino: String
TransactionID you are discussing the transaction with your (20)
processor. Not all processors provide this value.
All other
Cielo processors:
For Cielo, this value is the non-sequential unit String (15)
(NSU) and is supported for all transactions. The
value is generated by Cielo or the issuing bank.
Comercio Latino
For Comercio Latino, this value is the proof of sale
or non-sequential unit (NSU) number generated by
the acquirers Cielo and Rede, or the issuing bank.
CyberSource through VisaNet and GPN
For details about this value for CyberSource
through VisaNet and GPN, see Appendix Q,
"Network Transaction Identifiers," on page 498.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 373
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Personal identifier result. This field is supported Authorization String (1)
personalIDCode only for Redecard in Brazil for CyberSource Latin
American Processing. If you included billTo_
personalID in the request, this value indicates
whether billTo_personalID matched a value in a
record on file. Returned only when the personal ID
result is returned by the processor. Possible
values:
 Y: Match
 N: No match
 K: Not supported
 U: Unknown
 Z: No response returned
Note CyberSource Latin American Processing is
the name of a specific processing connection that
CyberSource supports. In the CyberSource API
documentation, CyberSource Latin American
Processing does not refer to the general topic of
processing in Latin America.The information in this
field description is for the specific processing
connection called CyberSource Latin American
Processing. It is not for any other Latin American
processors that CyberSource supports.

ccAuthReply_posData Point-of-sale details for the transaction. This value Authorization String (12)
is returned only on American Express Direct.
CyberSource generates this value, which consists
of a series of codes that identify terminal
capability, security data, and specific conditions
present at the time the transaction occurred. To
comply with the CAPN requirements, this value
must be included in all subsequent follow-on
requests, such as captures and follow-on credits.
When you perform authorizations, captures, and
credits through CyberSource, CyberSource
passes this value from the authorization service to
the subsequent services for you. However, when
you perform authorizations through CyberSource
and perform subsequent services through other
financial institutions, you must ensure that your
requests for captures and credits include this
value. See "Authorization Only," page 127.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 374
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ For most processors, this is the error message Authorization JCN
processorResponse sent directly from the bank. Returned only when Gateway:
the processor returns this value. String (3)
Important Do not use this field to evaluate the All other
result of the authorization. processors:
String (10)
AIBMS
If this value is 08, you can accept the transaction if
the customer provides you with identification.
Atos
This value is the response code sent from Atos
and it might also include the response code from
the bank.
Format: aa,bb with the two values separated by a
comma and where:
 aa is the two-digit error message from Atos.
 bb is the optional two-digit error message from
the bank.
Comercio Latino
This value is the status code and the error or
response code received from the processor
separated by a colon.
Format: [status code]:E[error code] or
[status code]:R[response code]
Example 2:R06
JCN Gateway
Processor-defined detail error code. The
associated response category code is in the
additionalProcessorResponse field.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 375
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Processor transaction ID. Authorization Cielo and
processorTransactionID CyberSource
Cielo and CyberSource Latin American
Latin
Processing
American
This value is a unique identifier for the transaction.
Processing:
Moneris String (50)
This value identifies the transaction on a host
Moneris:
system. It contains the following information:
Positive
 Terminal used to process the transaction Integer (18)
 Shift during which the transaction took place
 Batch number
 Transaction number within the batch
You must store this value. If you give the customer
a receipt, display this value on the receipt.
Example For the value
66012345001069003:
 Terminal ID = 66012345
 Shift number = 001
 Batch number = 069
 Transaction number = 003
ccAuthReply_ Numeric value corresponding to the result of the Authorization Integer (5)
reasonCode authorization request. See Reason Codes.
ccAuthReply_ Reference number for the transaction. This value Authorization Atos:
reconciliationID is not returned for all processors. See Table 9, Integer (6)
"Fields for Reconciliation IDs," on page 31 for the
All other
list of processors for which this value is returned.
processors:
See Getting Started with CyberSource Advanced
String (60)
for the Simple Order API for information about
order tracking and reconciliation.
ccAuthReply_ Ingenico ePayments Authorization String (20)
reconciliationReference Unique number generated by CyberSource that
Number identifies the transaction. You can use this value to
identify transactions in the Ingenico ePayments
Collections Report, which provides settlement
information.
CyberSource through VisaNet
Retrieval request number.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 376
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Referral response number for a verbal Authorization String (6)
referralResponse authorization with FDMS Nashville when using an
Number American Express card. Give this number to
American Express when you call them for the
verbal authorization.
ccAuthReply_ Amount you requested to be authorized. This Authorization String (15)
requestAmount value is returned for partial authorizations as
described in "Partial Authorizations," page 105.
ccAuthReply_ Currency for the amount you requested to be Authorization String (5)
requestCurrency authorized. This value is returned for partial
authorizations as described in "Partial
Authorizations," page 105. For the possible
values, see the ISO Standard Currency Codes.
ccAuthReply_ Transaction identification (TID) that is used to Authorization String (15)
transactionID identify and track a transaction throughout its life
cycle. This value is returned only on American
Express Direct.
American Express generates this value. To comply
with the CAPN requirements, this value must be
included in all subsequent follow-on requests,
such as captures and follow-on credits.
When you perform authorizations, captures, and
credits through CyberSource, CyberSource
passes this value from the authorization service to
the subsequent services for you. However, when
you perform authorizations through CyberSource
and perform subsequent services through other
financial institutions, you must ensure that your
requests for captures and credits include this
value. See "Authorization Only," page 127.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 377
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReply_ Transaction integrity classification provided by Authorization String (2)
transactionIntegrity Mastercard. This value specifies Mastercard’s
evaluation of the transaction’s safety and security.
This field is returned only on CyberSource through
VisaNet.
For card-present transactions, possible values:
 A1: EMV or token in a secure, trusted
environment
 B1: EMV or chip equivalent
 C1: Magnetic stripe
 E1: Key entered
 U0: Unclassified
For card-not-present transactions, possible
values:
 A2: Digital transactions
 B2: Authenticated checkout
 C2: Transaction validation
 D2: Enhanced data
 E2: Generic messaging
 U0: Unclassified
For information about these values, contact
Mastercard or your acquirer.
CyberSource through VisaNet
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR6
 Position: 136-137
 Field: Mastercard Transaction Integrity
Classification
ccAuthReversalReply_ Amount that was reversed. Authorization String (15)
amount Reversal
ccAuthReversalReply_ Authorization code. Returned only when the Authorization String (6)
authorizationCode authorization code is returned by the processor. Reversal
ccAuthReversalReply_ Name of the Japanese acquirer that processed the Authorization String (32)
forwardCode transaction. Returned only on JCN Gateway. Reversal
Contact the CyberSource Japan Support Group
for more information.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 378
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccAuthReversalReply_ Processor response code. Authorization JCN
processorResponse Reversal Gateway:
JCN Gateway
String (3)
Processor-defined detail error code. The
associated response category code is in the All other
additionalProcessorResponse field. processors:
String (10)
ccAuthReversalReply_ Processor transaction ID. This field is supported Authorization Positive
processorTransactionID only on Moneris. Reversal Integer (18)
This value identifies the transaction on a host
system. It contains the following information:
 Terminal used to process the transaction
 Shift during which the transaction took place
 Batch number
 Transaction number within the batch
You must store this value. If you give the customer
a receipt, display this value on the receipt.
Example For the value
66012345001069003:
 Terminal ID = 66012345
 Shift number = 001
 Batch number = 069
 Transaction number = 003
ccAuthReversalReply_ Numeric value corresponding to the result of the Authorization Integer (5)
reasonCode full authorization reversal request. See Reason Reversal
Codes.
ccAuthReversalReply_ Reference number for the transaction. This value Authorization String (60)
reconciliationID is not returned for all processors. See Table 9, Reversal
"Fields for Reconciliation IDs," on page 31 for the
list of processors for which this value is returned.
See Getting Started with CyberSource Advanced
for the Simple Order API for information about
order tracking and reconciliation.
ccAuthReversalReply_ Date and time when the service was requested. Authorization Date and
requestDateTime Reversal time (20)
ccCaptureReply_amount Amount that was captured. Capture String (15)
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 379
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccCaptureReply_ Processor transaction ID. This value identifies the Capture Positive
processorTransactionID transaction on a host system. This value is Integer (18)
supported only on Moneris. It contains this
information:
 Terminal used to process the transaction
 Shift during which the transaction took place
 Batch number
 Transaction number within the batch
You must store this value. If you give the customer
a receipt, display this value on the receipt.
Example For the value
66012345001069003:
 Terminal ID = 66012345
 Shift number = 001
 Batch number = 069
 Transaction number = 003
ccCaptureReply_ Numeric value corresponding to the result of the Capture Integer (5)
reasonCode capture request. See Reason Codes.
ccCaptureReply_ Reference number that you use to reconcile your Capture Atos:
reconciliationID CyberSource reports with your processor reports. Integer (6)
See Getting Started with CyberSource Advanced
FDC
for the Simple Order API for information about
Nashville
order tracking and reconciliation.
Global:
String (8)
All other
processors:
String (60)
ccCaptureReply_ Unique number generated by CyberSource that Capture String (20)
reconciliationReference identifies the transaction. You can use this value to
Number identify transactions in the Ingenico ePayments
Collections Report, which provides settlement
information. This field is supported only on
Ingenico ePayments.
ccCaptureReply_ Date and time when the service was requested. Capture Date and
requestDateTime time (20)
ccCheckStatusReply_ Authorization code. Returned only when the Check Status String (6)
authorizationCode payment status is AUTHORIZED.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 380
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccCheckStatusReply_ Authorization status. Possible values: Check Status String (20)
paymentStatus
 AUTHORIZED
 DECLINED
ccCheckStatusReply_ Numeric value corresponding to the result of the Check Status Integer (5)
reasonCode check status request. See Reason Codes.
ccCreditReply_amount Amount that was credited. Credit String (15)
ccCreditReply_ Credit authorization code. Returned only when the Credit String (6)
authorizationCode issuer returns this value and CyberSource
authorizes the credit as described in "Credit
Authorizations," page 84.
This field is supported only on CyberSource
through VisaNet.
ccCreditReply_ Name of the Japanese acquirer that processed the Credit String (32)
forwardCode transaction. Returned only on JCN Gateway.
Contact the CyberSource Japan Support Group
for more information.
ccCreditReply_ Merchant ID that was used to create the Credit String (30)
ownerMerchantID subscription or customer profile for which the
service was requested.
Payment Tokenization
When your account is enabled for Payment
Tokenization, this field is returned only when you
use profile sharing and when your merchant ID is
in the same merchant ID pool as the owner
merchant ID. See the profile sharing information in
Payment Tokenization Using the Simple Order
API.
Recurring Billing
When your account is enabled for Recurring
Billing, this field is returned only when you use
subscription sharing and when your merchant ID is
in the same merchant ID pool as the owner
merchant ID. See the subscription sharing
information in Recurring Billing Using the Simple
Order API.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 381
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccCreditReply_ Network transaction identifier (TID). You can use Credit String (15)
paymentNetwork this value to identify a specific transaction when
TransactionID you are discussing the transaction with your
processor. Returned only when CyberSource
authorizes the credit as described in "Credit
Authorizations," page 84.
This field is supported only on CyberSource
through VisaNet.
ccCreditReply_ Error message. Returned only when CyberSource Credit String (10)
processorResponse authorizes the credit as described in "Credit
Authorizations," page 84.
This field is supported only on CyberSource
through VisaNet.
ccCreditReply_ Processor transaction ID. This value identifies the Credit Positive
processorTransactionID transaction on a host system. This value is Integer (18)
supported only on Moneris. It contains this
information:
 Terminal used to process the transaction
 Shift during which the transaction took place
 Batch number
 Transaction number within the batch
You must store this value. If you give the customer
a receipt, display this value on the receipt.
Example For the value
66012345001069003:
 Terminal ID = 66012345
 Shift number = 001
 Batch number = 069
 Transaction number = 003
ccCreditReply_ Numeric value corresponding to the result of the Credit Integer (5)
reasonCode credit request. See Reason Codes.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 382
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccCreditReply_ Reference number that you use to reconcile your Credit Atos:
reconciliationID CyberSource reports with your processor reports. Integer (6)
See Getting Started with CyberSource Advanced
FDC
for the Simple Order API for information about
Nashville
order tracking and reconciliation.
Global:
String (8)
All other
processors:
String (60)
ccCreditReply_ Unique number generated by CyberSource that Credit String (20)
reconciliationReference identifies the transaction. You can use this value to
Number identify transactions in the Ingenico ePayments
Collections Report, which provides settlement
information. This field is supported only on
Ingenico ePayments.
ccCreditReply_ Date and time when the service was requested. Credit Date and
requestDateTime time (20)
ccIncrementalAuthReply_ Amount that was authorized. Incremental String (15)
amount Authorization
ccIncrementalAuthReply_ Authorization code. Returned only when the Incremental String (7)
authorizationCode processor returns this value. Authorization
ccIncrementalAuthReply_ Date and time of authorization. Incremental Date and
authorizedDateTime Authorization time (20)
ccIncrementalAuthReply_ Visa product ID. For descriptions of the Visa Incremental String (3)
cardCategory product IDs, see the Product ID table on the Visa Authorization
Request & Response Codes web page at
https://developer.visa.com/guides/request_
response_codes.
ccIncrementalAuthReply_ Network transaction identifier (TID). You can use Incremental String (15)
paymentNetwork this value to identify a specific transaction when Authorization
TransactionID you are discussing the transaction with your
processor.
ccIncrementalAuthReply_ Error message sent directly from the issuing bank. Incremental String (10)
processorResponse Returned only when the processor returns this Authorization
value.
Important Do not use this field to evaluate the
result of the incremental authorization.
ccIncrementalAuthReply_ Numeric value corresponding to the result of the Incremental Integer (5)
reasonCode incremental authorization request. See Reason Authorization
Codes.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 383
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ccIncrementalAuthReply_ Reference number for the transaction. See Getting Incremental String (60)
reconciliationID Started with CyberSource Advanced for the Authorization
Simple Order API for information about order
tracking and reconciliation.
decision Summarizes the result of the overall request. All CyberSource String (6)
Possible values: services
 ACCEPT
 ERROR
 REJECT
 REVIEW: Returned only when you use
CyberSource Decision Manager.
For details about these values, see the information
about handling replies in Getting Started with
CyberSource Advanced for the Simple Order API.

installment_ Additional costs charged by the issuer to fund the Authorization String (12)
additionalCosts installment payments. This field is supported for
two kinds of installment payments in Brazil on
CyberSource through VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 128-139
 Field: Total Other Costs
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 384
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Additional costs divided by the amount funded. For Authorization String (4)
additionalCosts example:
Percentage
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments in Brazil on CyberSource through
VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 140-143
 Field: Percent of Total Other Costs
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 385
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_amount Amount of the current installment payment. This Authorization String (12)
field is supported for Mastercard installment
payments on CyberSource through VisaNet in all
countries except Croatia and Georgia. See
"Installment Payments on CyberSource through
VisaNet," page 150.
Brazil
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 26-37
 Field: Amount of Each Installment
Greece
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 23-34
 Field: Amount of Each Installment
Other Countries
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 63-74
 Field: Mastercard Subsequent Installment
Amount
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 386
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Amount funded. This field is supported for two Authorization String (12)
amountFunded kinds of installment payments in Brazil on
CyberSource through VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 48-59
 Field: Total Amount Funded
installment_ Amount requested divided by the amount funded. Authorization String (4)
amountRequested For example:
Percentage
 A value of 90.0 specifies 90%.
 A value of 93.7 specifies 93.7%.
This field is supported for two kinds of installment
payments in Brazil on CyberSource through
VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 60-63
 Field: Percent of Amount Requested
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 387
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Annual cost of financing the installment payments. Authorization String (7)
annualFinancingCost
This field is included in the authorization reply for
the Crediario eligibility request when the issuer
approves the customer's request for Crediario
installment payments in Brazil. See "Installment
Payments on CyberSource through VisaNet,"
page 150.
This field is supported only for Crediario
installment payments in Brazil on CyberSource
through VisaNet.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 158-164
 Field: Annual Total Cost of Financing
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 388
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Annual interest rate. For example: Authorization String (7)
annualInterestRate
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments on CyberSource through VisaNet:
 Crediario with Visa in Brazil: this field is
included in the authorization reply for the
Crediario eligibility request when the issuer
approves the customer's request for Crediario
installment payments.
 Mastercard in all countries except Brazil,
Croatia, Georgia, and Greece.
See "Installment Payments on CyberSource
through VisaNet," page 150.
Brazil
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 151-157
 Field: Annual Interest Rate
Other Countries
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 58-62
 Field: Mastercard Annual Percentage Rate
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 389
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_expenses Expenses charged by the issuer to fund the Authorization String (12)
installment payments. This field is supported for
two kinds of installment payments in Brazil on
CyberSource through VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 64-75
 Field: Total Expenses
installment_ Expenses divided by the amount funded. For Authorization String (4)
expensesPercentage example:
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments in Brazil on CyberSource through
VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 76-79
 Field: Percent of Total Expenses
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 390
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_fees Fees charged by the issuer to fund the installment Authorization String (12)
payments. This field is supported for two kinds of
installment payments on CyberSource through
VisaNet:
 Crediario with Visa in Brazil: this field is
included in the authorization reply for the
Crediario eligibility request when the issuer
approves the customer's request for Crediario
installment payments.
 Mastercard in all countries except Croatia,
Georgia, and Greece.
See "Installment Payments on CyberSource
through VisaNet," page 150.
Brazil
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 80-91
 Field: Total Fees
Other Countries
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 46-57
 Field: Mastercard Installment Fee
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 391
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Fees divided by the amount funded. For example: Authorization String (4)
feesPercentage
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments in Brazil on CyberSource through
VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 92-95
 Field: Percent of Total Fees
installment_ Amount of the first installment payment. The issuer Authorization String (12)
firstInstallmentAmount provides this value when the first installment
payment is successful. This field is supported for
Mastercard installment payments on CyberSource
through VisaNet in all countries except Brazil,
Croatia, Georgia, and Greece. See "Installment
Payments on CyberSource through VisaNet,"
page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 23-34
 Field: Amount of Each Installment
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 392
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Date of the first installment payment. This field is Authorization String (6)
firstInstallmentDate supported for Mastercard installment payments on
CyberSource through VisaNet in Greece. See
"Installment Payments on CyberSource through
VisaNet," page 150.
Format: YYMMDD.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 102-107
 Field: Mastercard Greece First Installment Due
Date
installment_insurance Insurance charged by the issuer to fund the Authorization String (12)
installment payments. This field is supported for
two kinds of installment payments in Brazil on
CyberSource through VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 112-123
 Field: Total Insurance
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 393
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Insurance costs divided by the amount funded. For Authorization String (4)
insurancePercentage example:
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments in Brazil on CyberSource through
VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 124-127
 Field: Percent Of Total Insurance
installment_ Maximum number of installments offered by the Authorization String (2)
maximumTotalCount issuer for this purchase. The issuer provides this
value when the first installment payment is
successful.
This field is supported for installment payments
with Mastercard on CyberSource through VisaNet
in all countries except Brazil, Croatia, Georgia,
and Greece. See "Installment Payments on
CyberSource through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 77-78
 Field: Mastercard Maximum Number Of
Installments
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 394
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Minimum number of installments offered by the Authorization String (2)
minimumTotalCount issuer for this purchase. The issuer provides this
value when the first installment payment is
successful.
This field is supported for installment payments
with Mastercard on CyberSource through VisaNet
in all countries except Brazil, Croatia, Georgia,
and Greece. See "Installment Payments on
CyberSource through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 75-76
 Field: Mastercard Minimum Number Of
Installments
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 395
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_ Monthly interest rate. For example: Authorization String (7)
monthlyInterestRate
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments on CyberSource through VisaNet:
 Crediario with Visa in Brazil: this field is
included in the authorization reply for the
Crediario eligibility request when the issuer
approves the customer's request for Crediario
installment payments.
 Mastercard in all countries except Croatia,
Georgia, and Greece.
See "Installment Payments on CyberSource
through VisaNet," page 150.
Brazil
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 144-150
 Field: Monthly Interest Rate
Other Countries
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 41-45
 Field: Mastercard Interest Rate
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 396
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_taxes Taxes collected by the issuer to fund the Authorization String (12)
installment payments. This field is supported for
two kinds of installment payments in Brazil on
CyberSource through VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 96-107
 Field: Total Taxes
installment_ Taxes divided by the amount funded. For example: Authorization String (4)
taxesPercentage
 A value of 1.0 specifies 1%.
 A value of 4.0 specifies 4%.
This field is supported for two kinds of installment
payments in Brazil on CyberSource through
VisaNet:
 Crediario with Visa: this field is included in the
authorization reply for the Crediario eligibility
request when the issuer approves the
customer's request for Crediario installment
payments
 Mastercard
See "Installment Payments on CyberSource
through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 108-111
 Field: Percentage of Total Taxes
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 397
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
installment_totalAmount Total amount of the loan that is being paid in Authorization String (12)
installments. This field is supported for installment
payments with Mastercard on CyberSource
through VisaNet in all countries except Croatia,
Georgia, and Greece. See "Installment Payments
on CyberSource through VisaNet," page 150.
Brazil
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR9
 Position: 8-19
 Field: Installment Total Amount
Other Countries
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 5-16
 Field: Installment Payment Total Amount
installment_totalCount Total number of installments. This field is Authorization Integer (2)
supported for installment payments with
Mastercard on CyberSource through VisaNet in all
countries except Brazil, Croatia, Georgia, and
Greece. See "Installment Payments on
CyberSource through VisaNet," page 150.
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR5
 Position: 20-22
 Field: Number Of Installments
invalidField_0 through Fields in the request that have invalid data. For All CyberSource String (100)
invalidField_N information about missing or invalid fields, see services
Getting Started with CyberSource Advanced for
the Simple Order API.
Note These fields are included as an aid to
software developers only. Do not use these fields
to interact with your customers.

1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 398
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
issuer_additionalData Data defined by the issuer. The value for this reply Authorization String (255)
field will probably be the same as the value that
Authorization
you submitted in the authorization request, but it is
Reversal
possible for the processor, issuer, or acquirer to
modify the value. For more information, see Capture
Appendix N, "Formats for Discretionary Data," on
page 487.
This field is supported only for Visa transactions
on CyberSource through VisaNet.
issuer_message Text message from the issuer. If you give the Incremental String (250)
customer a receipt, display this value on the Authorization
receipt.
merchantReference Order reference or tracking number that you All CyberSource String (50)
Code provided in the request. If you included multi-byte services
characters in this field in the request, the returned
value might include corrupted characters.
FDC Nashville Global
Order reference or tracking number that you
provided in the request. If the request did not
include a merchant reference number, this value is
provided by the client software that is installed on
the POS terminal.
There are some special circumstances in which
the processor truncates this value to 15 or 17
characters for Level II and Level III processing.
This can cause a discrepancy between the value
you submit and the value included in some
processor reports.
SIX
Order reference or tracking number that you
provided in the request. If the request did not
include a merchant reference number, this value is
provided by the client software that is installed on
the POS terminal.
missingField_0 through Required fields that were missing from the All CyberSource String (100)
missingField_N request. For information about missing or invalid services
fields, see Getting Started with CyberSource
Advanced for the Simple Order API.
Note These fields are included as an aid to
software developers only. Do not use these fields
to interact with your customers.

1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 399
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
originalTransaction_ Amount of the original transaction. See "Merchant- Authorization String (15)
amount Initiated Reversals and Voids," page 170. Reversal
Void
originalTransaction_ Reason code for the original transaction. See Authorization Integer (5)
reasonCode "Merchant-Initiated Reversals and Voids," Reversal
page 170, and Reason Codes.
Void
purchaseTotals_currency Currency used for the order. For the possible Authorization String (5)
values, see the ISO Standard Currency Codes.
Authorization
DCC with a Third-Party Provider Reversal
Your customer’s billing currency For details, see
Capture
"Dynamic Currency Conversion with a Third Party
Provider," page 133. Credit
Incremental
Authorization
reasonCode Numeric value corresponding to the result of the All CyberSource Integer (5)
overall request. See Reason Codes. services
receiptNumber This field is returned only on American Express Authorization String (6)
Direct and CyberSource through VisaNet.
Incremental
American Express Direct Authorization
System trace audit number (STAN). This value
identifies the transaction and is useful when
investigating a chargeback dispute.
CyberSource through VisaNet
System trace number that must be printed on the
customer’s receipt.
requestID Identifier for the request. All CyberSource String (26)
services
requestToken Request token data created by CyberSource for All CyberSource String (256)
each reply. The field is an encoded string that services
contains no confidential information such as an
account or card verification number. The string can
contain a maximum of 256 characters.
When you request the authorization and capture
services together, the request token is for the
capture reply only.
Atos
You must store the contents of this field so that you
can retrieve and send it in follow-on requests.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 400
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
ucaf_collectionIndicator Universal cardholder authentication field (UCAF) ccAuthService String with
collection indicator to which the transaction was numbers
downgraded. For the description and only (1)
requirements, see "Payer Authentication,"
page 186.
This field is returned only for downgraded
Mastercard Identity Check transactions on
CyberSource through VisaNet.
CyberSource through VisaNet
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR7
 Position: 5
 Field: Mastercard Electronic Commerce
Indicators—UCAF Collection Indicator
ucaf_ Reason the transaction was downgraded. When ccAuthService String (1)
downgradeReason you set the e-commerce indicator to a value that
Code indicates that Mastercard Identity Check data is
included in the request, Mastercard provides this
response value when the transaction is
downgraded. See "Payer Authentication,"
page 186. Possible values:
 0: The ucaf_authenticationData field is
missing.
 1: The value for the ucaf_authenticationData
field is invalid.
This field is returned only for downgraded
Mastercard Identity Check transactions on
CyberSource through VisaNet.
CyberSource through VisaNet
The value for this field corresponds to the following
data in the TC 33 capture file1:
 Record: CP01 TCR6
 Position: 80
 Field: Mastercard Electronic Commerce
Indicators
voidReply_amount Amount that was voided. Void String (15)
voidReply_currency Currency used for the order. For the possible Void String (5)
values, see the ISO Standard Currency Codes.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 401
 Appendix A API Fields

Table 56 Reply Fields (Continued)

Field Description Returned By Data Type

& Length
voidReply_reasonCode Numeric value corresponding to the result of the Void Integer (5)
void request. See Reason Codes.
voidReply_ Date and time when the service was requested. Void Date and
requestDateTime time (20)
voidReply_ Flag indicating whether a full authorization Void String (5)
reversalSubmitted reversal was successfully submitted. Possible
values:
 true: The authorization reversal was
successfully submitted.
 false: The authorization reversal was not
successfully submitted. You must send a credit
request for a refund.
This field is supported only on FDC Nashville
Global.
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.
CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who
uses this information to facilitate end-of-day clearing processing with payment networks.

Credit Card Services Using the Simple Order API | September 2019 402
 APPENDIX
Examples
B

Name-Value Pair Examples

Basic Credit Card Examples

Example 4 Credit Card Authorization Request

ccAuthService_run=true
merchantID=Napa Valley Vacations
merchantReferenceCode=482046C3A7E94F5
billTo_firstName=John
billTo_lastName=Doe
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_postalCode=94043
billTo_country=US
billTo_phoneNumber=650-965-6000
[email protected]
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD
card_expirationMonth=12
card_expirationYear=2015
card_accountNumber=4111111111111111
card_cardType=001

Credit Card Services Using the Simple Order API | September 2019 403
 Appendix B Examples

Example 5 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

requestID=0305782650000167905080
decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5
purchaseTotals_currency=USD
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_reasonCode=100
ccAuthReply_amount=49.95
ccAuthReply_accountBalance=50.05
ccAuthReply_authorizationCode=123456
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345

Example 6 Credit Card Capture Request

ccCaptureService_authRequestID=0305782650000167905080
merchantID=Napa Valley Vacations
merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
ccCaptureService_run=true
item_0_unitPrice=49.95
purchaseTotals_currency=USD

Example 7 Credit Card Capture Reply

requestID=1019827520348290570293
merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
decision=ACCEPT
reasonCode=100
ccCaptureReply_amount=49.95
purchaseTotals_currency=USD
ccCaptureReply_reasonCode=100
ccCaptureReply_reconciliationID=1094820975023470

Credit Card Services Using the Simple Order API | September 2019 404
 Appendix B Examples

Example 8 Credit Card Follow-on Credit Request

merchantID=Napa Valley Vacations

merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
purchaseTotals_grandTotalAmount=1694.00
purchaseTotals_currency=EUR
ccCreditService_run=true
ccCreditService_captureRequestID=1019827520348290570293

Example 9 Credit Card Follow-on Credit Reply

merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
requestID=1019827520348290570293
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=EUR
ccCreditReply_reasonCode=100
ccCreditReply_amount=1694.00
ccCreditReply_reconciliationID=C3A7E94F5BD1FE3C64820466C

Credit Card Services Using the Simple Order API | September 2019 405
 Appendix B Examples

Asia, Middle East, and Africa Gateway Examples

Example 10 Credit Card Authorization Request with Payer Authentication Data

shipTo_firstName=Jane
shipTo_lastName=Smith
shipTo_street1=1234 ABCD Street
shipTo_city=Mountain View
shipTo_state=CA
shipTo_country=US
shipTo_postalCode=94043
billTo_firstName=John
billTo_lastName=Doe
billTo_street1=1295 Charleston Road
billTo_city=Mountain View
billTo_state=CA
billTo_country=US
billTo_postalCode=94043
billTo_ipAddress=10.7.7.7
[email protected]
billTo_phoneNumber=650-965-6000
merchantReferenceCode=0123456789
purchaseTotals_currency=USD
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2020
card_cardType=001
ccAuthService_commerceIndicator=vbv
ccAuthService_xid=WhPlErd9WE2pb12345HlewUIQwQ
ccAuthService_veresEnrolled=Y
ccAuthService_paresStatus=Y
ccAuthService_cavv=PpmBUYXt2uyt12345mAb8XgnOk
ccAuthService_run=true
item_0_unitPrice=12.34
item_1_unitPrice=56.78

Example 11 Credit Card Authorization Reply

ccAuthReply_avsCode=2
ccAuthReply_amount=69.12
ccAuthReply_reasonCode=100
ccAuthReply_reconciliationID=19119123440
ccAuthReply_processorResponse=0
ccAuthReply_authorizationCode=ABC12345
requestID=1921371701234567904567
reasonCode=100
decision=ACCEPT
merchantReferenceCode=0123456789
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 406
 Appendix B Examples

Cielo Examples
Example 12 Automatic Capture Request with Elo

merchantID=Foster City Flowers

merchantReferenceCode=Transaction-Cielo-NTA-3
billTo_firstName=Júlia
billTo_lastName=Fernández
billTo_buildingNumber=1024
billTo_street1=R. Augustã
billTo_street2=Bloco 01
billTo_city=São Paulo
billTo_district=Bela Vista
billTo_state=SP
billTo_postalCode=01310-000
billTo_country=BR
billTo_phoneNumber=999-999-9999
[email protected]
purchaseTotals_currency=usd
purchaseTotals_grandTotalAmount=104.00
card_accountNumber=1234567812345678
card_expirationMonth=03
card_expirationYear=2031
card_cardType=054
ccAuthService_run=true
ccAuthService_authType=AUTOCAPTURE
ccCaptureService_run=true

Example 13 Automatic Capture Reply with Elo

merchantReferenceCode=Transaction-Cielo-NTA-3
requestID=4231489930765000001540
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=usd
ccAuthReply_reasonCode=100
ccAuthReply_amount=104.00
ccAuthReply_authorizationCode=123456
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=CC
ccAuthReply_processorResponse=00
ccAuthReply_reconciliationID=Auth12345678
ccAuthReply_paymentNetworkTransactionID=333138
ccAuthReply_processorTransactionID=00142308609746028231
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=104.00
ccCaptureReply_reconciliationID=Auth12345678

Credit Card Services Using the Simple Order API | September 2019 407
 Appendix B Examples

Example 14 Debit Card Request with Maestro (International)

merchantID=Foster City Flowers

merchantReferenceCode=Transaction-Cielo-NTA-4
billTo_firstName=Júlia
billTo_lastName=Fernández
billTo_buildingNumber=1024
billTo_street1=R. Augustã
billTo_street2=Bloco 01
billTo_city=São Paulo
billTo_district=Bela Vista
billTo_state=SP
billTo_postalCode=01310-000
billTo_country=BR
billTo_phoneNumber=999-999-9999
[email protected]
purchaseTotals_currency=brl
purchaseTotals_grandTotalAmount=106.00
card_accountNumber=123456781234567812
card_expirationMonth=03
card_expirationYear=2031
card_cvIndicator=1
card_cvNumber=123
card_cardType=042
ucaf_authenticationData=WhPlErd9WE2pb1yFjFHlewUIQwQ=
ucaf_collectionIndicator=2
ccAuthService_run=true
ccAuthService_commerceIndicator=spa
ccAuthService_xid=lEmYpm61EduaVZjPG1/HsgkAAQc=
ccAuthService_overridePaymentMethod=DB
ccCaptureService_run=true

Example 15 Debit Card Reply with Maestro (International)

merchantReferenceCode=Transaction-Cielo-NTA-4
requestID=4231489990775000001540
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=brl
ccAuthReply_reasonCode=100
ccAuthReply_amount=106.00
ccAuthReply_authorizationCode=123456
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=CC
ccAuthReply_processorResponse=00
ccAuthReply_reconciliationID=Auth12345678
ccAuthReply_paymentNetworkTransactionID=333138
ccAuthReply_processorTransactionID=00142308609746028231
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=106.00
ccCaptureReply_reconciliationID=Auth12345678

Credit Card Services Using the Simple Order API | September 2019 408
 Appendix B Examples

Example 16 Installment Request with Visa

merchantID=Foster City Flowers

merchantReferenceCode=Transaction-Cielo-NTA-1
billTo_firstName=Júlia
billTo_lastName=Fernández
billTo_buildingNumber=1024
billTo_street1=R. Augustã
billTo_street2=Bloco 01
billTo_city=São Paulo
billTo_district=Bela Vista
billTo_state=SP
billTo_postalCode=01310-000
billTo_country=BR
billTo_phoneNumber=999-999-9999
[email protected]
item_0_unitPrice=51025.00
item_0_quantity=1
purchaseTotals_currency=brl
installment_totalCount=4
installment_planType=1
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2018
card_cardType=001
ccAuthService_run=true

Example 17 Installment Reply with Visa

merchantReferenceCode=Transaction-Cielo-NTA-1
requestID=4231493140785000001540
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=brl
ccAuthReply_reasonCode=100
ccAuthReply_amount=51025.00
ccAuthReply_authorizationCode=123456
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=CC
ccAuthReply_processorResponse=00
ccAuthReply_reconciliationID=Auth12345678
ccAuthReply_paymentNetworkTransactionID=333138
ccAuthReply_processorTransactionID=00142308609746028231

Credit Card Services Using the Simple Order API | September 2019 409
 Appendix B Examples

CyberSource Latin American Processing Examples

CyberSource Latin American Processing is the name of a specific processing

connection that CyberSource supports. In the CyberSource API
Note documentation, CyberSource Latin American Processing does not refer to the
general topic of processing in Latin America. These examples are for the
specific processing connection called CyberSource Latin American
Processing. They are not for any other Latin American processors that
CyberSource supports.

Example 18 Credit Card Authorization Request for Redecard in Brazil with AVS

ccAuthService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=1234567890
billTo_firstName=Adriana
billTo_lastName=Tavares da Silva
billTo_street1=Rua da Quitanda 187
billTo_buildingNumber=187
billTo_city=Rio de Janeiro
billTo_postalCode=20091-005
billTo_country=BR
billTo_phoneNumber=+552121114700
[email protected]
billTo_personalID=987654321
item_0_quantity=1
item_0_unitPrice=49.95
purchaseTotals_currency=BRL
card_cardType=052
card_accountNumber=5432543254325432
card_expirationMonth=12
card_expirationYear=2015

Example 19 Credit Card Authorization Reply

decision=ACCEPT
reasonCode=100
requestID=12345678901234567890
merchantReferenceCode=1234567
purchaseTotals_currency=BRL
ccAuthReply_reasonCode=100
ccAuthReply_personalIDCode=Y
ccAuthReply_amount=49.95
ccAuthReply_authorizationCode=123456
ccAuthReply_reconciliationID=1911912456
ccAuthReply_avsCode=V

Credit Card Services Using the Simple Order API | September 2019 410
 Appendix B Examples

Incremental Authorization Examples

Example 20 Incremental Authorization Request

ccIncrementalAuthService_run=true
purchaseTotals_grandTotalAmount=101.00
purchaseTotals_currency=USD
merchantID=Napa Valley Vacations
merchantReferenceCode=33557799
ccIncrementalAuthService_authRequestID=3434254100000181552556
subsequentAuthReason=2

Example 21 Incremental Authorization Reply

requestID=3524892270000181552556
decision=ACCEPT
reasonCode=100
merchantReferenceCode=33557799
purchaseTotals_currency=usd
additionalData=00612012345678910000000008160003359
ccIncrementalAuthReply_amount=101.00
ccIncrementalAuthReply_authorizationCode=831000
ccIncrementalAuthReply_processorResponse=A
ccIncrementalAuthReply_paymentNetworkTransactionID=016153570198200
ccIncrementalAuthReply_reasonCode=100
ccIncrementalAuthReply_reconciliationID=3524892270000181552556
ccIncrementalAuthReply_cardCategory=J1
receiptNumber=841215

Credit Card Services Using the Simple Order API | September 2019 411
 Appendix B Examples

Partial Authorization Examples

Fully Approved Request

The following two examples consist of an authorization request that is fully approved, and
the subsequent authorization reply, which includes balance information:
 Original request amount: 1500.00 USD
 Approved amount: 1500.00 USD
 Balance amount: 23.62 USD positive

Example 22 Fully Approved Authorization Request

ccAuthService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=AB1234.1-1
billTo_firstName=John
billTo_lastName=Smith
billTo_street1=201 S. Division St.
billTo_street2=Suite 500
billTo_city=Ann Arbor
billTo_state=MI
billTo_country=US
billTo_postalCode=48104-2201
[email protected]
billTo_phoneNumber=123-456-7890
card_accountNumber=4111111111111111
card_cardType=001
card_cvNumber=xxx
card_expirationMonth=12
card_expirationYear=2015
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=1500.00

Credit Card Services Using the Simple Order API | September 2019 412
 Appendix B Examples

Example 23 Fully Approved Authorization Reply

Most processors do not return all the fields in this example.

Note

merchantReferenceCode=AB1234.1-1
requestID=2688497722340000852964
decision=ACCEPT
reasonCode=100
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_reasonCode=100
ccAuthReply_amount=1500.00
ccAuthReply_avsCode=A
ccAuthReply_avsCodeRaw=A
ccAuthReply_authorizationCode=831000
ccAuthReply_processorResponse=000
ccAuthReply_accountBalance=23.62
ccAuthReply_accountBalanceCurrency=USD
ccAuthReply_accountBalanceSign=positive
ccAuthReply_cardCategory=J1
ccAuthReply_cardGroup=0
ccAuthReply_cvCode=3
ccAuthReply_merchantAdviceCode=00
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 413
 Appendix B Examples

Partially Approved Request

The following two examples consist of an authorization request that is partially approved
and the subsequent authorization reply:
 Original request amount: 1401.00 USD
 Approved amount: 500.00 USD

Example 24 Partially Approved Authorization Request

ccAuthService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=AB1234.1-1
billTo_firstName=John
billTo_lastName=Smith
billTo_street1=201 S. Division St.
billTo_street2=Suite 500
billTo_city=Ann Arbor
billTo_state=MI
billTo_country=US
billTo_postalCode=48104-2201
[email protected]
billTo_phoneNumber=123-456-7890
card_accountNumber=4111111111111111
card_cardType=001
card_cvNumber=xxx
card_expirationMonth=12
card_expirationYear=2015
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=1401.00

Credit Card Services Using the Simple Order API | September 2019 414
 Appendix B Examples

Example 25 Partially Approved Authorization Reply

Most processors do not return all the fields in this example.

Note

merchantReferenceCode=AB1234.1-1
requestID=2688497722340000852964
decision=REJECT
reasonCode=110
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_reasonCode=110
ccAuthReply_amount=500.00
ccAuthReply_avsCode=A
ccAuthReply_avsCodeRaw=A
ccAuthReply_authorizationCode=831000
ccAuthReply_processorResponse=010
ccAuthReply_requestAmount=1401.00
ccAuthReply_requestCurrency=USD
ccAuthReply_cardCategory=J1
ccAuthReply_cardGroup=0
ccAuthReply_cvCode=3
ccAuthReply_merchantAdviceCode=00
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 415
 Appendix B Examples

RuPay Examples
Example 26 Credit Card Authorization Request

merchantID=RuPayMerchant1
merchantReferenceCode=ABCDE12345
billTo_firstName=Jane
billTo_lastName=Smith
billTo_street1=123 Main Street
billTo_city=Any Town
billTo_state=CA
billTo_postalCode=99999-1234
billTo_country=IN
billTo_phoneNumber=999-999-9999
[email protected]
billTo_ipAddress=123.4.567.89
purchaseTotals_currency=INR
purchaseTotals_grandTotalAmount=120.00
card_accountNumber=5088888888888
card_expirationMonth=12
card_expirationYear=2025
card_cvNumber=123
card_cardType=061
ccAuthService_run="true"
ccAuthService_cavv=XYZAV54321XYZAV54321XYZAV54321XYZAV54321
ccAuthService_commerceIndicator=rpy
ccAuthService_xid=ODI4MTEyMjU5ODAy

Example 27 Credit Card Authorization Reply

merchantReferenceCode=ABCDE12345
requestID=5391708182936018401540
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=INR
ccAuthReply_reasonCode=100
ccAuthReply_amount=120.00
ccAuthReply_authorizationCode=183217
ccAuthReply_processorResponse=ABCDE12345
ccAuthReply_reconciliationID=1094820975023470

Example 28 Check Status Request

merchantID=RuPayMerchant1
merchantReferenceCode=ABCDE12345
ccCheckStatusService_run="true"
ccCheckStatusService_authRequestID=5391708182936018401540

Credit Card Services Using the Simple Order API | September 2019 416
 Appendix B Examples

Example 29 Check Status Reply

merchantReferenceCode=ABCDE12345
requestID=3951708182936018401450
decision=ACCEPT
reasonCode=100
ccCheckStatusReply_reasonCode=100
ccCheckStatusReply_paymentStatus=AUTHORIZED
ccCheckStatusReply_authorizationCode=183217

Split-Shipment Examples

One Authorization and One Sale

Example 30 Credit Card Authorization Request

ccAuthService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
billTo_firstName=John
billTo_lastName=Doe
billTo_phoneNumber=650-965-6000
[email protected]
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_country=US
billTo_postalCode=94043
card_expirationMonth=12
card_expirationYear=2015
card_accountNumber=4111111111111111
card_cardType=001
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 417
 Appendix B Examples

Example 31 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=0305782650000167905080
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_reasonCode=100
ccAuthReply_amount=49.95
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_authorizationCode=123456
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD

Example 32 Sale Request

ccAuthService_run=true
ccCaptureService_run=true
linkToRequest=0305782650000167905080
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
billTo_firstName=John
billTo_lastName=Doe
billTo_phoneNumber=650-965-6000
[email protected]
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_country=US
billTo_postalCode=94043
card_expirationMonth=12
card_expirationYear=2015
card_accountNumber=4111111111111111
card_cardType=001
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 418
 Appendix B Examples

Example 33 Sale Reply

Most processors do not return all the fields in this example.

Note

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=1416783769994859
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_reasonCode=100
ccAuthReply_amount=49.95
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_authorizationCode=123456
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=49.95
ccCaptureReply_reconciliationID=02850840187309570

Credit Card Services Using the Simple Order API | September 2019 419
 Appendix B Examples

One Authorization and Two Captures

Example 34 Credit Card Authorization Request

ccAuthService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
billTo_firstName=John
billTo_lastName=Doe
billTo_phoneNumber=650-965-6000
[email protected]
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_country=US
billTo_postalCode=94043
card_expirationMonth=12
card_expirationYear=2015
card_accountNumber=4111111111111111
card_cardType=001
item_0_unitPrice=52.00
item_0_quantity=1
item_1_unitPrice=16.00
item_1_quantity=1
purchaseTotals_currency=USD

Example 35 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=0305782650000167905080
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_reasonCode=100
ccAuthReply_amount=68.00
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_authorizationCode=123456
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 420
 Appendix B Examples

Example 36 First Credit Card Capture Request

ccCaptureService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
ccCaptureService_authRequestID=0305782650000167905080
item_0_unitPrice=52.00
item_0_quantity=1
purchaseTotals_currency=USD

Example 37 First Credit Card Capture Reply

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=1019827520348290570293
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=52.00
ccCaptureReply_reconciliationID=02850840187309570
purchaseTotals_currency=USD

Example 38 Second Credit Card Capture Request

ccCaptureService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
ccCaptureService_authRequestID=0305782650000167905080
item_0_unitPrice=16.00
item_0_quantity=1
purchaseTotals_currency=USD

Example 39 Second Credit Card Capture Reply

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=49601835arbl569cj
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=16.00
ccCaptureReply_reconciliationID=sl59vu2nh4ek9lq
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 421
 Appendix B Examples

Two Authorizations and One Capture

Example 40 First Credit Card Authorization Request

ccAuthService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
billTo_firstName=John
billTo_lastName=Doe
billTo_phoneNumber=650-965-6000
[email protected]
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_country=US
billTo_postalCode=94043
card_expirationMonth=12
card_expirationYear=2015
card_accountNumber=4111111111111111
card_cardType=001
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD

Example 41 First Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=0305782650000167905080
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_reasonCode=100
ccAuthReply_amount=49.95
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_authorizationCode=123456
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 422
 Appendix B Examples

Example 42 Second Credit Card Authorization Request

ccAuthService_run=true
linkToRequest=0305782650000167905080
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
billTo_firstName=John
billTo_lastName=Doe
billTo_phoneNumber=650-965-6000
[email protected]
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_country=US
billTo_postalCode=94043
card_expirationMonth=12
card_expirationYear=2015
card_accountNumber=4111111111111111
card_cardType=001
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD

Example 43 Second Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=1416783769994859
ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_reasonCode=100
ccAuthReply_amount=49.95
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_authorizationCode=123456
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD

Credit Card Services Using the Simple Order API | September 2019 423
 Appendix B Examples

Example 44 Credit Card Capture Request

ccCaptureService_run=true
merchantID=Foster City Flowers
merchantReferenceCode=482046C3A7E94F5BD1
ccCaptureService_authRequestID=1416783769994859
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD

Example 45 Credit Card Capture Reply

decision=ACCEPT
reasonCode=100
merchantReferenceCode=482046C3A7E94F5BD1
requestID=1019827520348290570293
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=49.95
ccCaptureReply_reconciliationID=02850840187309570
purchaseTotals_currency=USD

Visa Checkout and Visa Secure Remote Commerce

Examples
Example 46 Credit Card Authorization Request

ccAuthService_run=true
merchantID=Foster_City_Flowers
merchantReferenceCode=123456
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=25.00
paymentSolution=visacheckout
vc_orderID=335161017227386762

Credit Card Services Using the Simple Order API | September 2019 424
 Appendix B Examples

Example 47 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

ccAuthReply_reconciliationID=ABCDE12345FGHIJ67890
ccAuthReply_cardCategory=F^
ccAuthReply_cardGroup=0
ccAuthReply_amount=25.00
ccAuthReply_avsCode=Y
ccAuthReply_authorizationCode=831000
ccAuthReply_processorResponse=00
ccAuthReply_avsCodeRaw=Y
ccAuthReply_reasonCode=100
ccAuthReply_paymentNetworkTransactionID=3312345
purchaseTotals_currency=USD
decision=ACCEPT
reasonCode=100
merchantReferenceCode=123456
requestID=4068437426340172492292

Credit Card Services Using the Simple Order API | September 2019 425
 Appendix B Examples

Worldpay VAP Examples

Example 48 Credit Card Sale Request with Least-Cost Routing

merchantID=My_Store
merchantReferenceCode=Order_158
invoiceHeader_merchantDescriptor=Business_Name
invoiceHeader_merchantDescriptorContact=999-999-9999
invoiceHeader_merchantDescriptorAlternate=Business_Email@example.com
invoiceHeader_merchantDescriptorCity=Business_City
billTo_firstName=Jane
billTo_middleName=Anne
billTo_lastName=Smith
billTo_street1=1234 Main St.
billTo_street2=Suite 500
billTo_city=Foster City
billTo_state=CA
billTo_postalCode=94404
billTo_country=US
billTo_phoneNumber=650-999-9999
[email protected]
billTo_ipAddress=111.111.111.111
billTo_customerID=Customer_1234
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=5000
pos_entryMode=keyed
pos_cardPresent=y
pos_terminalCapability=2
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2022
card_cvIndicator=1
card_cvNumber=000
ccAuthService_run=true
ccAuthService_commerceIndicator=retail
ccAuthService_leastCostRouting=y
ccCaptureService_run=true
reportGroup=Report_Group_1234

Credit Card Services Using the Simple Order API | September 2019 426
 Appendix B Examples

Example 49 Credit Card Sale Reply

merchantReferenceCode=Order_158
requestID=5459942086076547903095
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=USD
ccAuthReply_reasonCode=100
ccAuthReply_amount=5000.00
ccAuthReply_authorizationCode=123456
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=00
ccAuthReply_cvCode=M
ccAuthReply_cvCodeRaw=M
ccAuthReply_processorResponse=000
ccAuthReply_reconciliationID=5459942086076547903095
ccAuthReply_accountBalance=0.00
ccAuthReply_paymentNetworkTransactionID=1234567890123456
ccAuthReply_cardCategory=PREPAID
ccAuthReply_affluenceIndicator=MASS AFFLUENT
ccAuthReply_cardIssuerCountry=USA
ccAuthReply_processorTransactionID=1234567
ccCaptureReply_reasonCode=100
ccCaptureReply_amount=5000.00
ccCaptureReply_reconciliationID=5459942086076547903095
card_cardType=001
card_suffix=1111
card_virtual=true
card_prepaidReloadable=NO
card_prepaidType=GIFT

Credit Card Services Using the Simple Order API | September 2019 427
 Appendix B Examples

XML Examples

Basic Credit Card Examples

Example 50 Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.23">
<merchantID>Napa Valley Vacations</merchantID>
<merchantReferenceCode>482046C3A7E94F5</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>001</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 428
 Appendix B Examples

Example 51 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.23">
<c:merchantReferenceCode>482046C3A7E94F5</c:merchantReferenceCode>
<c:requestID>0305782650000167905080</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>YYY</c:avsCodeRaw>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:accountBalance>50.05</c:accountBalance>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Example 52 Credit Card Capture Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.37">
<merchantID>Napa Valley Vacations</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1FE3C66C</merchantReferenceCode>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<ccCaptureService run="true">
<authRequestID>0305782650000167905080</authRequestID>
</ccCaptureService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 429
 Appendix B Examples

Example 53 Credit Card Capture Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.37">
<c:merchantReferenceCode>482046C3A7E94F5BD1FE3C66C</c:merchantReferenceCode>
<c:requestID>1019827520348290570293</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:reconciliationID>1094820975023470</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Example 54 Credit Card Follow-on Credit Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.86">
<merchantID>Napa Valley Vacations</merchantID>
<merchantReferenceCode>482046C3A7E94F5BDC66C</merchantReferenceCode>
<purchaseTotals>
<currency>EUR</currency>
<grandTotalAmount>1694.00</grandTotalAmount>
</purchaseTotals>
<ccCreditService run="true">
<captureRequestID>1019827520348290570293</captureRequestID>
</ccCreditService>
</requestMessage>

Example 55 Credit Card Follow-on Credit Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.86">
<c:merchantReferenceCode>482046C3A75BD1FE3C66C</c:merchantReferenceCode>
<c:requestID>9057101982752034820293</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>EUR</c:currency>
</c:purchaseTotals>
<c:ccCreditReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>1694.00</c:amount>
<c:reconciliationID>C3A7E94F5BD1FE3C64820466C</c:reconciliationID>
</c:ccCreditReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 430
 Appendix B Examples

Asia, Middle East, and Africa Gateway Examples

Example 56 Credit Card Authorization Request with Payer Authentication Data

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.32">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>0123456789</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Road</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
<ipAddress>10.7.7.7</ipAddress>
</billTo>
<shipTo>
<firstName>Jane</firstName>
<lastName>Smith</lastName>
<street1>1234 ABCD Street</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
</shipTo>
<item id="0">
<unitPrice>12.34</unitPrice>
</item>
<item id="1">
<unitPrice>56.78</unitPrice>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2020</expirationYear>
<cvNumber>1234</cvNumber>
<cardType>001</cardType>
</card>
<ccAuthService run="true">
<cavv>PpmBUYXt2uytV6p12345KuImAb8XgnOk</cavv>
<commerceIndicator>vbv</commerceIndicator>
<xid>WhPlErd9WE1234562pb1yFjFHlewUIQwQ</xid>
<veresEnrolled>Y</veresEnrolled>
<paresStatus>Y</paresStatus>
</ccAuthService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 431
 Appendix B Examples

Example 57 Credit Card Authorization Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.32">
<c:merchantReferenceCode>0123456789</c:merchantReferenceCode>
<c:requestID>1921312345620167904567</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>69.12</c:amount>
<c:authorizationCode>ABC12345</c:authorizationCode>
<c:avsCode>2</c:avsCode>
<c:cvCode>2</c:cvCode>
<c:cvCodeRaw>Q</c:cvCodeRaw>
<c:processorResponse>0</c:processorResponse>
<c:reconciliationID>19119123438</c:reconciliationID>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 432
 Appendix B Examples

Cielo Examples
Example 58 Automatic Capture Request with Elo

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.111">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>Transaction-Cielo-NTA-3</merchantReferenceCode>
<billTo>
<firstName>Júlia</firstName>
<lastName>Fernández</lastName>
<buildingNumber>1024</buildingNumber>
<street1>R. Augustã</street1>
<street2>Bloco 01</street2>
<city>São Paulo</city>
<district>Bela Vista</district>
<state>SP</state>
<postalCode>01310-000</postalCode>
<country>BR</country>
<phoneNumber>999-999-9999</phoneNumber>
<email>[email protected]</email>
</billTo>
<purchaseTotals>
<currency>usd</currency>
<grandTotalAmount>104.00</grandTotalAmount>
</purchaseTotals>
<card>
<accountNumber>1234567812345678</accountNumber>
<expirationMonth>03</expirationMonth>
<expirationYear>2031</expirationYear>
<cardType>054</cardType>
</card>
<ccAuthService run="true">
<authType>AUTOCAPTURE</authType>
</ccAuthService>
<ccCaptureService run="true"></ccCaptureService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 433
 Appendix B Examples

Example 59 Automatic Capture Reply with Elo

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.111">
<c:merchantReferenceCode>Transaction-Cielo-NTA-3</c:merchantReferenceCode>
<c:requestID>4231489930765000001540</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>usd</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>104.00</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>CC</c:avsCodeRaw>
<c:processorResponse>00</c:processorResponse>
<c:reconciliationID>Auth12345678</c:reconciliationID>
<c:paymentNetworkTransactionID>333138</c:paymentNetworkTransactionID>
<c:processorTransactionID>00142308609746028231</c:processorTransactionID>
</c:ccAuthReply>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>104.00</c:amount>
<c:reconciliationID>Auth12345678</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 434
 Appendix B Examples

Example 60 Debit Card Request with Maestro (International)

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.111">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>Transaction-Cielo-NTA-4</merchantReferenceCode>
<billTo>
<firstName>Júlia</firstName>
<lastName>Fernández</lastName>
<buildingNumber>1024</buildingNumber>
<street1>R. Augustã</street1>
<street2>Bloco 01</street2>
<city>São Paulo</city>
<district>Bela Vista</district>
<state>SP</state>
<postalCode>01310-000</postalCode>
<country>BR</country>
<phoneNumber>999-999-9999</phoneNumber>
<email>[email protected]</email>
</billTo>
<purchaseTotals>
<currency>brl</currency>
<grandTotalAmount>106.00</grandTotalAmount>
</purchaseTotals>
<card>
<accountNumber>123456781234567812</accountNumber>
<expirationMonth>03</expirationMonth>
<expirationYear>2031</expirationYear>
<cvIndicator>1</cvIndicator>
<cvNumber>123</cvNumber>
<cardType>042</cardType>
</card>
<ucaf>
<authenticationData>WhPlErd9WE2pb1yFjFHlewUIQwQ=</authenticationData>
<collectionIndicator>2</collectionIndicator>
</ucaf>
<ccAuthService run="true">
<commerceIndicator>spa</commerceIndicator>
<xid>lEmYpm61EduaVZjPG1/HsgkAAQc=</xid>
<overridePaymentMethod>DB</overridePaymentMethod>
</ccAuthService>
<ccCaptureService run="true"></ccCaptureService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 435
 Appendix B Examples

Example 61 Debit Card Reply with Maestro (International)

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.111">
<c:merchantReferenceCode>Transaction-Cielo-NTA-4</c:merchantReferenceCode>
<c:requestID>4231489990775000001540</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>brl</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>106.00</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>CC</c:avsCodeRaw>
<c:processorResponse>00</c:processorResponse>
<c:reconciliationID>Auth12345678</c:reconciliationID>
<c:paymentNetworkTransactionID>333138</c:paymentNetworkTransactionID>
<c:processorTransactionID>00142308609746028231</c:processorTransactionID>
</c:ccAuthReply>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>106.00</c:amount>
<c:reconciliationID>Auth12345678</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 436
 Appendix B Examples

Example 62 Installment Request with Visa

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.111">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>Transaction-Cielo-NTA-1</merchantReferenceCode>
<billTo>
<firstName>Júlia</firstName>
<lastName>Fernández</lastName>
<buildingNumber>1024</buildingNumber>
<street1>R. Augustã</street1>
<street2>Bloco 01</street2>
<city>São Paulo</city>
<district>Bela Vista</district>
<state>SP</state>
<postalCode>01310-000</postalCode>
<country>BR</country>
<phoneNumber>999-999-9999</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>51025.00</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>brl</currency>
</purchaseTotals>
<installment>
<totalCount>4</totalCount>
<planType>1</planType>
</installment>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2018</expirationYear>
<cardType>001</cardType>
</card>
<ccAuthService run="true"></ccAuthService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 437
 Appendix B Examples

Example 63 Installment Reply with Visa

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.111">
<c:merchantReferenceCode>Transaction-Cielo-NTA-1</c:merchantReferenceCode>
<c:requestID>4231493140785000001540</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>brl</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>51025.00</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>CC</c:avsCodeRaw>
<c:processorResponse>00</c:processorResponse>
<c:reconciliationID>Auth12345678</c:reconciliationID>
<c:paymentNetworkTransactionID>333138</c:paymentNetworkTransactionID>
<c:processorTransactionID>00142308609746028231</c:processorTransactionID>
</c:ccAuthReply>
</c:replyMessage>

CyberSource Latin American Processing Examples

CyberSource Latin American Processing is the name of a specific processing

connection that CyberSource supports. In the CyberSource API
Note documentation, CyberSource Latin American Processing does not refer to the
general topic of processing in Latin America. These examples are for the
specific processing connection called CyberSource Latin American
Processing. They are not for any other Latin American processors that
CyberSource supports.

Credit Card Services Using the Simple Order API | September 2019 438
 Appendix B Examples

Example 64 Credit Card Authorization Request for Redecard in Brazil with AVS

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.41">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>1234567890</merchantReferenceCode>
<billTo>
<firstName>Adriana</firstName>
<lastName>Tavares da Silva</lastName>
<street1>Rua da Quitanda 187</street1>
<city>Rio de Janeiro</city>
<postalCode>20091-005</postalCode>
<country>BR</country>
<phoneNumber>+552121114700</phoneNumber>
<email>[email protected]</email>
<personalID>987654321</personalID>
<buildingNumber>187</buildingNumber>
</billTo>
<item id="0"><unitPrice>49.95</unitPrice></item>
<purchaseTotals><currency>BRL</currency></purchaseTotals>
<card>
<accountNumber>5432543254325432</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>052</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Example 65 Credit Card Authorization Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.41">
<c:merchantReferenceCode>1234567</c:merchantReferenceCode>
<c:requestID>12345678901234567890</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals><c:currency>BRL</c:currency></c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>V</c:avsCode>
<c:personalIDCode>Y</c:personalIDCode>
<c:reconciliationID>19119123456</c:reconciliationID>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 439
 Appendix B Examples

Incremental Authorization Examples

Example 66 Incremental Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.23">
<merchantID>Napa Valley Vacations</merchantID>
<merchantReferenceCode>33557799</merchantReferenceCode>
<purchaseTotals>
<currency>USD</currency>
<grandTotalAmount>101.00</grandTotalAmount>
</purchaseTotals>
<ccIncrementalAuthService run="true">
<authRequestID>3434254100000181552556</authRequestID>
</ccIncrementalAuthService>
<subsequentAuthReason>2</subsequentAuthReason>
</requestMessage>

Example 67 Incremental Authorization Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.23">
<c:merchantReferenceCode>482046C3A7E94F5</c:merchantReferenceCode>
<c:requestID>0305782650000167905080</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccIncrementalAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>101.00</c:amount>
<c:authorizationCode>831000</c:authorizationCode>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>3524892270000181552556</c:reconciliationID>
<c:paymentNetworkTransactionID>016153570198200</c:paymentNetworkTransactionID>
<c:cardCategory>J1</c:cardCategory>
</c:ccIncrementalAuthReply>
<c:receiptNumber>841215</c:receiptNumber>
<c:additionalData>00612012345678910000000008160003359</c:additionalData>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 440
 Appendix B Examples

Partial Authorization Examples

Fully Approved Request

The following two examples consist of an authorization request that is fully approved, and
the subsequent authorization reply, which includes balance information:
 Original request amount: 1500.00 USD
 Approved amount: 1500.00 USD
 Balance amount: 23.62 USD positive

Example 68 Fully Approved Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.52">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>AB1234.1-1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Smith</lastName>
<street1>201 S. Division St.</street1>
<street2>Suite 500</street2>
<city>Ann Arbor</city>
<state>MI</state>
<postalCode>48104-2201</postalCode>
<country>US</country>
<phoneNumber>123-456-7890</phoneNumber>
<email>[email protected]</email>
</billTo>
<purchaseTotals>
<currency>USD</currency>
<grandTotalAmount>1500.00</grandTotalAmount>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cvNumber>xxx</cvNumber>
<cardType>001</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 441
 Appendix B Examples

Example 69 Fully Approved Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.52">
<c:merchantReferenceCode>AB1234.1-1</c:merchantReferenceCode>
<c:requestID>2688497722340000852964</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals><c:currency>USD</c:currency></c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>1500.00</c:amount>
<c:authorizationCode>831000</c:authorizationCode>
<c:avsCode>A</c:avsCode>
<c:avsCodeRaw>A</c:avsCodeRaw>
<c:cvCode>3</c:cvCode>
<c:processorResponse>000</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:merchantAdviceCode>00</c:merchantAdviceCode>
<c:accountBalance>23.62</c:accountBalance>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>J1</c:cardCategory>
<c:accountBalanceCurrency>USD</c:accountBalanceCurrency>
<c:accountBalanceSign>positive</c:accountBalanceSign>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 442
 Appendix B Examples

Partially Approved Request

The following two examples consist of an authorization request that is partially approved
and the subsequent authorization reply:
 Original request amount: 1401.00 USD
 Approved amount: 500.00 USD

Example 70 Partially Approved Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.52">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>AB1234.1-1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Smith</lastName>
<street1>201 S. Division St.</street1>
<street2>Suite 500</street2>
<city>Ann Arbor</city>
<state>MI</state>
<postalCode>48104-2201</postalCode>
<country>US</country>
<phoneNumber>123-456-7890</phoneNumber>
<email>[email protected]</email>
</billTo>
<purchaseTotals>
<currency>USD</currency>
<grandTotalAmount>1401.00</grandTotalAmount>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cvNumber>xxx</cvNumber>
<cardType>001</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 443
 Appendix B Examples

Example 71 Partially Approved Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.52">
<c:merchantReferenceCode>AB1234.1-1</c:merchantReferenceCode>
<c:requestID>2688497722340000852964</c:requestID>
<c:decision>REJECT</c:decision>
<c:reasonCode>110</c:reasonCode>
<c:purchaseTotals><c:currency>USD</c:currency></c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>110</c:reasonCode>
<c:amount>500.00</c:amount>
<c:authorizationCode>831000</c:authorizationCode>
<c:avsCode>A</c:avsCode>
<c:avsCodeRaw>A</c:avsCodeRaw>
<c:cvCode>3</c:cvCode>
<c:processorResponse>010</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:merchantAdviceCode>00</c:merchantAdviceCode>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>J1</c:cardCategory>
<c:requestAmount>1401.00</c:requestAmount>
<c:requestCurrency>USD</c:requestCurrency>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 444
 Appendix B Examples

RuPay Examples
Example 72 Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.151">
<merchantID>RuPayMerchant1</merchantID>
<merchantReferenceCode>ABCDE12345</merchantReferenceCode>
<billTo>
<firstName>Jane</firstName>
<lastName>Smith</lastName>
<street1>123 Main Street</street1>
<city>Any Town</city>
<state>CA</state>
<postalCode>99999-1234</postalCode>
<country>IN</country>
<phoneNumber>999-999-9999</phoneNumber>
<email>[email protected]</email>
<ipAddress>123.4.567.89</ipAddress>
</billTo>
<purchaseTotals>
<currency>INR</currency>
<grandTotalAmount>120.00</grandTotalAmount>
</purchaseTotals>
<card>
<accountNumber>5088888888888</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2025</expirationYear>
<cvNumber>123</cvNumber>
<cardType>061</cardType>
</card>
<ccAuthService run="true">
<cavv>XYZAV54321XYZAV54321XYZAV54321XYZAV54321</cavv>
<commerceIndicator>rpy</commerceIndicator>
<xid>ODI4MTEyMjU5ODAy</xid>
</ccAuthService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 445
 Appendix B Examples

Example 73 Credit Card Authorization Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.151">
<c:merchantReferenceCode>ABCDE12345</c:merchantReferenceCode>
<c:requestID>5391708182936018401540</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>INR</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>120.00</c:amount>
<c:authorizationCode>183217</c:authorizationCode>
<c:processorResponse>ABCDE12345</c:processorResponse>
<c:reconciliationID>1094820975023470</c:reconciliationID>
</c:ccAuthReply>
</c:replyMessage>

Example 74 Check Status Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.151">
<merchantID>RuPayMerchant1</merchantID>
<merchantReferenceCode>ABCDE12345</merchantReferenceCode>
<ccCheckStatusService run="true">
<authRequestID>5391708182936018401540</authRequestID>
</ccCheckStatusService>
</requestMessage>

Example 75 Check Status Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.151">
<c:merchantReferenceCode>ABCDE12345</c:merchantReferenceCode>
<c:requestID>3951708182936018401450</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:ccCheckStatusReply>
<c:reasonCode>100</c:reasonCode>
<c:paymentStatus>AUTHORIZED</c:paymentStatus>
<c:authorizationCode>183217</c:authorizationCode>
</c:ccCheckStatusReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 446
 Appendix B Examples

Split-Shipment Examples

One Authorization and One Sale

Example 76 Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>001</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 447
 Appendix B Examples

Example 77 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>0305782650000167905080</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>YYY</c:avsCodeRaw>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 448
 Appendix B Examples

Example 78 Sale Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>001</cardType>
</card>
<linkToRequest>0305782650000167905080</linkToRequest>
<ccAuthService run="true"/>
<ccCaptureService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 449
 Appendix B Examples

Example 79 Sale Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>0305782650000167905080</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>YYY</c:avsCodeRaw>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:reconciliationID>02850840187309570</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 450
 Appendix B Examples

One Authorization and Two Captures

Example 80 Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>52.00</unitPrice>
<quantity>1</quantity>
</item>
<item id="1">
<unitPrice>16.00</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>001</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 451
 Appendix B Examples

Example 81 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>0305782650000167905080</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>68.00</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>YYY</c:avsCodeRaw>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Example 82 First Credit Card Capture Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<item id="0">
<unitPrice>52.00</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<ccCaptureService run="true">
<authRequestID>0305782650000167905080</authRequestID>
</ccCaptureService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 452
 Appendix B Examples

Example 83 First Credit Card Capture Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>1019827520348290570293</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>52.00</c:amount>
<c:reconciliationID>02850840187309570</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Example 84 Second Credit Card Capture Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<item id="0">
<unitPrice>16.00</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<ccCaptureService run="true">
<authRequestID>0305782650000167905080</authRequestID>
</ccCaptureService>
</requestMessage>

Example 85 Second Credit Card Capture Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>1019827520348290570293</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>16.00</c:amount>
<c:reconciliationID>sl59vu2nh4ek9lq</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 453
 Appendix B Examples

Two Authorizations and One Capture

Example 86 First Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>001</cardType>
</card>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 454
 Appendix B Examples

Example 87 First Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>0305782650000167905080</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>YYY</c:avsCodeRaw>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 455
 Appendix B Examples

Example 88 Second Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>[email protected]</email>
</billTo>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2015</expirationYear>
<cardType>001</cardType>
</card>
<linkToRequest>0305782650000167905080</linkToRequest>
<ccAuthService run="true"/>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 456
 Appendix B Examples

Example 89 Second Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>1416783769994859</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>YYY</c:avsCodeRaw>
<c:processorResponse>A</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Example 90 Credit Card Capture Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.40">
<merchantID>Foster City Flowers</merchantID>
<merchantReferenceCode>482046C3A7E94F5BD1</merchantReferenceCode>
<item id="0">
<unitPrice>49.95</unitPrice>
<quantity>1</quantity>
</item>
<purchaseTotals>
<currency>USD</currency>
</purchaseTotals>
<ccCaptureService run="true">
<authRequestID>1416783769994859</authRequestID>
</ccCaptureService>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 457
 Appendix B Examples

Example 91 Credit Card Capture Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.40">
<c:merchantReferenceCode>482046C3A7E94F5BD1</c:merchantReferenceCode>
<c:requestID>1019827520348290570293</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>49.95</c:amount>
<c:reconciliationID>02850840187309570</c:reconciliationID>
</c:ccCaptureReply>
</c:replyMessage>

Visa Checkout and Visa Secure Remote Commerce

Examples
Example 92 Credit Card Authorization Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.105">
<merchantID>Foster_City_Flowers</merchantID>
<merchantReferenceCode>123456</merchantReferenceCode>
<purchaseTotals>
<currency>USD</currency>
<grandTotalAmount>25.00</grandTotalAmount>
</purchaseTotals>
<ccAuthService_run="true"/>
<paymentSolution>visacheckout</paymentSolution>
<vc><orderID>335161017227386762</orderID></vc>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 458
 Appendix B Examples

Example 93 Credit Card Authorization Reply

Most processors do not return all the fields in this example.

Note

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.105">
<c:merchantReferenceCode>123456</c:merchantReferenceCode>
<c:requestID>4068437426340172492292</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>25.00</c:amount>
<c:authorizationCode>831000</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>Y</c:avsCodeRaw>
<c:processorResponse>00</c:processorResponse>
<c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
<c:paymentNetworkTransactionID>3312345</c:paymentNetworkTransactionID>
<c:cardCategory>F^</c:cardCategory>
<c:cardGroup>0</c:cardGroup>
</c:ccAuthReply>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 459
 Appendix B Examples

Worldpay VAP Examples

Example 94 Credit Card Sale Request with Least-Cost Routing

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.151">
<merchantID>My_Store</merchantID>
<merchantReferenceCode>Order_158</merchantReferenceCode>
<invoiceHeader>
<merchantDescriptor>Business_Name</merchantDescriptor>
<merchantDescriptorContact>999-999-9999</merchantDescriptorContact>
<merchantDescriptorAlternate>[email protected]</merchantDescriptorAlternate>
<merchantDescriptorCity>Business_City</merchantDescriptorCity>
</invoiceHeader>
<billTo>
<firstName>Jane</firstName>
<middleName>Anne</middleName>
<lastName>Smith</lastName>
<street1>1234 Main St.</street1>
<street2>Suite 500</street2>
<city>Foster City</city>
<state>CA</state>
<postalCode>94404</postalCode>
<country>US</country>
<phoneNumber>650-999-9999</phoneNumber>
<email>[email protected]</email>
<ipAddress>111.111.111.111</ipAddress>
<customerID>Customer_1234</customerID>
</billTo>
<purchaseTotals>
<currency>USD</currency>
<grandTotalAmount>5000</grandTotalAmount>
</purchaseTotals>
<pos>
<entryMode>keyed</entryMode>
<cardPresent>y</cardPresent>
<terminalCapability>2</terminalCapability>
</pos>
<card>
<accountNumber>4111111111111111</accountNumber>
<expirationMonth>12</expirationMonth>
<expirationYear>2022</expirationYear>
<cvIndicator>1</cvIndicator>
<cvNumber>000</cvNumber>
</card>
<ccAuthService run="true">
<commerceIndicator>retail</commerceIndicator>
<leastCostRouting>y</leastCostRouting>
</ccAuthService>
<ccCaptureService run="true"/>
<reportGroup>Report_Group_1234</reportGroup>
</requestMessage>

Credit Card Services Using the Simple Order API | September 2019 460
 Appendix B Examples

Example 95 Credit Card Sale Reply

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.151">
<c:merchantReferenceCode>Order_158</c:merchantReferenceCode>
<c:requestID>5459942086076547903095</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>USD</c:currency>
</c:purchaseTotals>
<c:ccAuthReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>5000.00</c:amount>
<c:authorizationCode>123456</c:authorizationCode>
<c:avsCode>Y</c:avsCode>
<c:avsCodeRaw>00</c:avsCodeRaw>
<c:cvCode>M</c:cvCode>
<c:cvCodeRaw>M</c:cvCodeRaw>
<c:processorResponse>000</c:processorResponse>
<c:reconciliationID>5459942086076547903095</c:reconciliationID>
<c:accountBalance>0.00</c:accountBalance>
<c:paymentNetworkTransactionID>1234567890123456</c:paymentNetworkTransactionID>
<c:cardCategory>PREPAID</c:cardCategory>
<c:affluenceIndicator>MASS AFFLUENT</c:affluenceIndicator>
<c:cardIssuerCountry>USA</c:cardIssuerCountry>
<c:processorTransactionID>1234567</c:processorTransactionID>
</c:ccAuthReply>
<c:ccCaptureReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>5000.00</c:amount>
<c:reconciliationID>5459942086076547903095</c:reconciliationID>
</c:ccCaptureReply>
<c:card>
<c:cardType>001</c:cardType>
<c:suffix>1111</c:suffix>
<c:virtual>true</c:virtual>
<c:prepaidReloadable>NO</c:prepaidReloadable>
<c:prepaidType>GIFT</c:prepaidType>
</c:card>
</c:replyMessage>

Credit Card Services Using the Simple Order API | September 2019 461
 APPENDIX
Additional Amount Types
C

Additional amount types are used with additional amounts, which are described in
"Additional Amounts," page 116.

Table 57 Additional Amount Types for Goods and Services

Goods and Services Code

Additional collection 102
Advance purchase for cabin upgrade 186
Advance purchase for excess baggage 184
Advance purchase for optional services 187
Advance purchase for preferred seat upgrade 185
Agency exchange order 119
Agency group ticket 120
Agency Miscellaneous charge order (MCO) 118
Agency passenger ticket 116
Agency tour order or voucher 117
Agent-assisted reservation or ticketing fee 168
Animal transportation charge 127
Bar 019
Bar or mini-bar 023
Barber or beauty salon 028
Beverage 017
Business center 036
Cabin update 166
Catalogue merchandise order 123
Catering charges 022
Checked sporting or special equipment 176
Club membership fee 143
Club membership fee or temporary trial 179
Convention fees 037
Coupon book 144

Credit Card Services Using the Simple Order API | September 2019 462
 Appendix C Additional Amount Types

Table 57 Additional Amount Types for Goods and Services (Continued)

Goods and Services Code

Credit for overcharge adjustment 136
Credit for unused transportation 130
Credit for class of service adjustment 131
Credit for denied boarding 132
Credit for exchange 135
Credit for lost ticket 134
Credit for miscellaneous refund 133
Credit for multiple unused tickets 137
Curbside baggage 173
Debit adjustment or duplicate refund 121
Dry ice fee 177
Duty-free sale 164
Excess baggage 103
Exchange adjustment 113
Exchange order 138
Firearms case 128
Food 016
Food and beverages 018
Frequent flyer fee or purchase 125
Frequent flyer fulfillment 148
Frequent flyer activation or reinstatement 180
Frequent flyer overnight delivery charge 147
Gift certificate 181
Gift shop 030
Group ticket 112
Health and fitness 029
In-flight adjustment 115
In-flight charges 145
In-flight duty-free purchase 141
In-flight merchandise order 122
In-flight phone charges 124
In-flight entertainment or internet access 190
In-flight medical equipment 174
Insurance purchased 052
Internet service 025

Credit Card Services Using the Simple Order API | September 2019 463
 Appendix C Additional Amount Types

Table 57 Additional Amount Types for Goods and Services (Continued)

Goods and Services Code

Kennel charge 126
Laundry or dry cleaning 027
Lodging 020
Lost ticket application 108
Lounge or club access or day pass 167
Mail or postage fee 178
Miscellaneous charge order (MCO) or prepaid ticket authorization 104
Miscellaneous taxes and fees 151
Movies or pay-per-view 026
Onboard/in-flight prepaid voucher 182
Optional services fee 183
Overweight bag fee 191
Packages 189
Passenger ticket 101
Pet fees 033
Phone 024
Preferred seat upgrade 165
Pro shop 031
Restaurant or room service 021
Reward program transaction 047
Self-service tickets 139
Senior citizen discount booklets 142
Sleep sets 192
Small package delivery 149
SPD or air freight 114
Special purchase fee 193
Special service ticket 105
Standby fee 172
Supported refund 106
Ticket by mail 110
Ticket change or cancel fee 169
Ticket or pass print fee 175
Tip or gratuity 058
Tour order voucher 109

Credit Card Services Using the Simple Order API | September 2019 464
 Appendix C Additional Amount Types

Table 57 Additional Amount Types for Goods and Services (Continued)

Goods and Services Code

Tour deposit 146
Tours 034
Travel agency fee 152
Trip insurance 170
Unaccompanied minor 171
Undercharge adjustment 111
Unsupported refund 107
Upgrade charge 129
Vendor refund 160
Vendor sale 150
WIFI 188

Table 58 Additional Amount Types for Charges and Fees

Charges and Fees Code

Additional miles / kilometers / distance 062
Auto rental adjustment 060
Cancellation adjustment 065
Charges added after check-out or departure 041
Convenience charge 050
Delivery charge 051
Discount 053
Equipment rental 035
Express service charge 040
Freight / shipping / handling 055
Fuel charge 061
Late return 063
Meeting or conference charges 038
Miscellaneous charges and fees 042
No show charge 039
Order processing charge 049
Parking fee 032
Policy adjustment 066
Repairs 064
Surcharge 048

Credit Card Services Using the Simple Order API | September 2019 465
 Appendix C Additional Amount Types

Table 58 Additional Amount Types for Charges and Fees (Continued)

Charges and Fees Code

Tickets and violations 054
Travel miscellaneous charges 075
Travel transaction fees 074

Table 59 Additional Amount Types for Taxes

Taxes Code
Airport tax 015
Circulation of merchandise and service tax (ICMS) 007
Consumption tax 002
Exempt—no GST charged 068
Goods and services tax (GST) 001
Harmonized sales tax (HST) 005
Income security and reform tax (ISR Income Tax) 011
Industrialized products federal tributary tax (IPI Federal Tributary) 008
Inland revenue income tax (IR Income Tax) 009
Insurance premium tax (IPT) 006
International students and scholars income tax (ISS Income Tax) 010
Miscellaneous tax 046
Occupancy tax 012
Provincial sales tax (PST) 003
Quebec sales tax (QST) 004
Room tax 013
Sales tax 056
Stamp duty 067
Surcharge tax 014
Ticket tax 043
Value added tax (VAT) 057

Credit Card Services Using the Simple Order API | September 2019 466
 APPENDIX
American Express SafeKey
Response Codes
D

The American Express SafeKey response code is returned in ccAuthReply_

cavvResponseCode in the reply message for an authorization request. See "American
Express SafeKey," page 187, for a description of American Express SafeKey.

Table 60 American Express SafeKey Response Codes

Response Description
Code
1 CAVV failed validation and authentication.
2 CAVV passed validation and authentication.
3 CAVV passed the validation attempt.
4 CAVV failed the validation attempt.
7 CAVV failed the validation attempt and the issuer is available.
8 CAVV passed the validation attempt and the issuer is available.
9 CAVV failed the validation attempt and the issuer is not available.
A CAVV passed the validation attempt and the issuer is not available.
U Issuer does not participate or 3D secure data was not used.
99 An unknown value was returned from the processor.

Credit Card Services Using the Simple Order API | September 2019 467
 APPENDIX
AVS Codes
E

The AVS code is returned in ccAuthReply_avsCode in the authorization reply message.

See "Address Verification System (AVS)," page 88, for a description of AVS.

AVS Codes for Cielo 3.0 and CyberSource

Latin American Processing

CyberSource Latin American Processing is the name of a specific processing

connection that CyberSource supports. In the CyberSource API
Note documentation, CyberSource Latin American Processing does not refer to the
general topic of processing in Latin America. The information in this section is
for the specific processing connection called CyberSource Latin American
Processing. It is not for any other Latin American processors that CyberSource
supports.

Table 61 AVS Codes for Cielo 3.0 and CyberSource Latin American
Processing

Code Description
D Partial match: postal code and address match.
E Not supported: AVS is not supported for this card type.
or
Invalid: the acquirer returned an unrecognized value for the AVS response.
F Partial match: postal code matches, but CPF and address do not match. 1
G Not supported: AVS not supported or not verified.
I No match: AVS information is not available.
K Partial match: CPF matches, but postal code and address do not match. 1
L Partial match: postal code and CPF match, but address does not match. 1
N No match: postal code, CPF, and address do not match. 1
1 CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.

Credit Card Services Using the Simple Order API | September 2019 468
 Appendix E AVS Codes

Table 61 AVS Codes for Cielo 3.0 and CyberSource Latin American
Processing (Continued)

Code Description
O Partial match: CPF and address match, but postal code does not match. 1
R Not supported: your implementation does not support AVS.
or
System unavailable.
T Partial match: address matches, but postal code and CPF do not match. 1
V Match: postal code, CPF, and address match. 1
1 CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.

AVS Codes for All Other Processors

Table 62 Types of AVS Codes

Type of Codes Codes Description

Codes for American F, H, K, L, O, T, For American Express cards only. For American
Express Cards V Express cards, you can receive Visa and CyberSource
AVS codes in addition to the American Express AVS
codes.
Note For CyberSource through VisaNet, the
American Express AVS codes are converted to Visa
AVS codes before they are returned to you. As a result,
you will not receive American Express AVS codes for
the American Express card type.

Credit Card Services Using the Simple Order API | September 2019 469
 Appendix E AVS Codes

Table 62 Types of AVS Codes (Continued)

Type of Codes Codes Description

International Visa B, C, D, G, I, The international and domestic alphabetic AVS codes
Codes M, P are the Visa standard AVS codes. CyberSource maps
the standard AVS return codes for other types of
Domestic Visa A, E, N, R, S,
payment cards, including American Express cards, to
Codes U, W, X, Y, Z
the Visa standard AVS codes.
AVS is considered either domestic or international,
depending on the location of the bank that issued the
customer’s payment card:
 When the bank is in the U.S., the AVS is domestic.
 When the bank is outside the U.S., the AVS is
international.
You should be prepared to handle domestic and
international AVS result codes:
 For international cards, you can receive domestic
AVS codes in addition to the international AVS
codes.
 For domestic cards, you can receive international
AVS codes in addition to the domestic AVS codes.
CyberSource Codes 1, 2, 3, 4 The numeric AVS codes are created by CyberSource
and are not standard Visa codes. These AVS codes
can be returned for any card type.

Table 63 AVS Codes

Code Description
A Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.
B Partial match: street address matches, but postal code is not verified. Returned only for
Visa cards not issued in the U.S.
C No match: street address and postal code do not match. Returned only for Visa cards
not issued in the U.S.
D&M Match: street address and postal code match. Returned only for Visa cards not issued in
the U.S.
E Invalid: AVS data is invalid or AVS is not allowed for this card type.
F Partial match: card member’s name does not match, but billing postal code matches.
G Not supported: issuing bank outside the U.S. does not support AVS.
H Partial match: card member’s name does not match, but street address and postal code
match. Returned only for the American Express card type.
I No match: address not verified. Returned only for Visa cards not issued in the U.S.
K Partial match: card member’s name matches, but billing address and billing postal code
do not match. Returned only for the American Express card type.

Credit Card Services Using the Simple Order API | September 2019 470
 Appendix E AVS Codes

Table 63 AVS Codes (Continued)

Code Description
L Partial match: card member’s name and billing postal code match, but billing address
does not match. Returned only for the American Express card type.
M See the entry for D & M.
N No match: one of the following:
 Street address and postal code do not match.
 Card member’s name, street address, and postal code do not match. Returned only
for the American Express card type.
O Partial match: card member’s name and billing address match, but billing postal code
does not match. Returned only for the American Express card type.
P Partial match: postal code matches, but street address not verified. Returned only for
Visa cards not issued in the U.S.
R System unavailable.
S Not supported: issuing bank in the U.S. does not support AVS.
T Partial match: card member’s name does not match, but street address matches.
Returned only for the American Express card type.
U System unavailable: address information unavailable for one of these reasons:
 The U.S. bank does not support AVS outside the U.S.
 The AVS in a U.S. bank is not functioning properly.
V Match: card member’s name, billing address, and billing postal code match. Returned
only for the American Express card type.
W Partial match: street address does not match, but 9-digit postal code matches.
X Match: street address and 9-digit postal code match.
Y Match: street address and 5-digit postal code match.
Z Partial match: street address does not match, but 5-digit postal code matches.
1 Not supported: one of the following:
 AVS is not supported for this processor or card type.
 AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource
Customer Support.
2 Unrecognized: the processor returned an unrecognized value for the AVS response.
3 Match: address is confirmed. Returned only for PayPal Express Checkout.
4 No match: address is not confirmed. Returned only for PayPal Express Checkout.
5 No match: no AVS code was returned by the processor.

Credit Card Services Using the Simple Order API | September 2019 471
 APPENDIX
Business Application
Identifiers
F

Send a business application identifier in the invoiceHeader_businessApplicationID

field.

Table 64 Business Application Identifiers

Identifier Description
AA Account to account
BB Business to business
BI Bank-initiated money transfer
BP Non-card bill payment
CC Cash claim
CI Cash in
CO Cash out
CP Card bill payment
FD Funds disbursement (general)
GD Government disbursement
GP Gambling payout other than online gambling
LO Loyalty and offers
MA Mobile air time payment
MD Merchant disbursement
MI Merchant-initiated money transfer
MP Face-to-face merchant payment
OG Online gambling payout
PD Payroll pension disbursement
PG Payment to government
PP Person to person
PS Payment for goods and services (general)
TU Top-up for enhanced prepaid loads
WT Wallet transfer

Credit Card Services Using the Simple Order API | September 2019 472
 APPENDIX
Card Types
G

The following table lists the card type values to use in ccAuthService and
ccCreditService requests. To see which cards can be handled by each processor, see
"Payment Processors," page 32.

CyberSource strongly recommends that you send the card type even if it is
optional for your processor and card type. Omitting the card type can cause the
Important transaction to be processed with the wrong card type.

Table 65 Card Types for Authorizations and Credits

Value Card Type

001 Visa
For all processors except Ingenico ePayments and SIX, the Visa Electron
card type is processed the same way that the Visa debit card is
processed. Use card type value 001 for Visa Electron.
Note Ingenico ePayments was previously called Global Collect.
002 Mastercard, Eurocard1: European regional brand of Mastercard.

003 American Express

004 Discover

005 Diners Club: see "Discover Acquisitions and Alliances," page 23.

006 Carte Blanche1

007 JCB1

014 EnRoute1

021 JAL1

024 Maestro (UK Domestic)1

1 For this card type, you must include the card_cardType field in your request for an authorization or a
stand-alone credit.
2 For this card type on Cielo 3.0, you must include the card_cardType field in your request for an
authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.
3 For this card type on Getnet and Rede, you must include the card_cardType field in your request for an
authorization or a stand-alone credit.

Credit Card Services Using the Simple Order API | September 2019 473
 Appendix G Card Types

Table 65 Card Types for Authorizations and Credits (Continued)

Value Card Type

031 Delta1: use this value only for Ingenico ePayments. For other processors,
use 001 for all Visa card types.
Note Ingenico ePayments was previously called Global Collect.
033 Visa Electron1: Use this value only for Ingenico ePayments and SIX. For
other processors, use 001 for all Visa card types.
Note Ingenico ePayments was previously called Global Collect.
034 Dankort1

036 Cartes Bancaires1

037 Carta Si1

039 Encoded account number1

040 UATP1

042 Maestro (International)1

050 Hipercard2,3

051 Aura

054 Elo3

061 RuPay

062 China UnionPay

1 For this card type, you must include the card_cardType field in your request for an authorization or a
stand-alone credit.
2 For this card type on Cielo 3.0, you must include the card_cardType field in your request for an
authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.
3 For this card type on Getnet and Rede, you must include the card_cardType field in your request for an
authorization or a stand-alone credit.

Credit Card Services Using the Simple Order API | September 2019 474
 APPENDIX
Chargeback Reason Codes
H

Chargeback Reason Codes for Visa

Table 66 Chargeback Reason Codes for Visa

Reason Description
Code
30 Services Not Provided or Merchandise Not Received
31 Error in Addition
41 Cancelled Recurring Transaction
50 Credit Posted as Purchase
53 Not as Described
56 Defective Merchandise
60 Requested Copy Illegible
61 Fraudulent Mail/Phone Order Transaction
71 Authorization Request Declined / Authorization Declined
72 No Authorization / Transaction Exceeds Floor Limit
74 Late Presentment
75 Cardholder Does Not Recognize the Transaction
79 Requested Transaction Information Not Received
82 Duplicate Processing
83 Nonpossession of Card
85 Credit Not Processed
86 Paid by Other Means
90 Nonreceipt of Merchandise

Credit Card Services Using the Simple Order API | September 2019 475
 Appendix H Chargeback Reason Codes

Chargeback Reason Codes for Mastercard

Table 67 Chargeback Reason Codes for Mastercard

Reason Description
Code
01 Requested Transaction Data Not Received
02 Requested Item Illegible
08 Requested / Required Authorization Not Obtained
12 Account Number Not on File
31 Transaction Amount Differs
34 Duplicate Processing
35 Card Not Valid or Expired
37 Fraudulent Mail/Phone Order Transaction
41 Cancelled Recurring Transaction
42 Late Presentment
47 Exceeds Floor Limit, Not Authorized, and Fraudulent Transactions
50 Credit Posted as a Debit
53 Cardholder Dispute Defective / Not as Described
54 Cardholder Dispute-Not Elsewhere (U.S. only)
55 Nonreceipt of Merchandise
59 Services Not Rendered
60 Credit Not Processed
63 Cardholder Does Not Recognize - Potential Fraud

Credit Card Services Using the Simple Order API | September 2019 476
 APPENDIX
Commerce Indicators
I

The commerce indicator is a request value that you send in the ccAuthService_
commerceIndicator and ccCreditService_commerceIndicator fields.

Table 68 Commerce Indicators

Values Description
aesk See "American Express SafeKey," page 187.
and
aesk_attempted
install See "Installment Payments," page 145.
and
install_internet
internet (default for E-commerce order placed using a web site. On Ingenico
authorizations) ePayments, internet is supported only for Cartes Bancaires
transactions.
Note Ingenico ePayments was previously called Global Collect.
js See "JCB J/Secure," page 188.
and
js_attempted
moto Mail order or telephone order. Not supported on Cielo or UATP.
On Ingenico ePayments, moto is supported only for Cartes
Bancaires transactions.
Note Ingenico ePayments was previously called Global Collect.
moto_cc Mail order or telephone order from a call center. This value is
available only on the Asia, Middle East, and Africa Gateway.
pb See "ProtectBuy," page 195.
and
pb_attempted
recurring See "Recurring Payments," page 207.
and
 recurring—U.S. transaction or non-U.S. mail order /
recurring_internet
telephone order (MOTO) transaction
 recurring_internet—non-U.S. e-commerce (Internet)
transaction
retail See Card-Present Processing Using the Simple Order API.

Credit Card Services Using the Simple Order API | September 2019 477
 Appendix I Commerce Indicators

Table 68 Commerce Indicators (Continued)

Values Description
spa See "Mastercard Identity Check," page 189.
and
spa_failure
vbv, See "Visa Secure," page 197.
vbv_attempted,
and
vbv_failure

Credit Card Services Using the Simple Order API | September 2019 478
 APPENDIX
CVN Codes
J

The CVN code is returned in ccAuthReply_cvCode in the authorization reply message.

See "Card Verification Numbers (CVNs)," page 97, for a description of CVN.

Table 69 CVN Codes

Code Description
D The transaction was determined to be suspicious by the issuing bank.
I The CVN failed the processor's data validation check.
M The CVN matched.
N The CVN did not match.
P The CVN was not processed by the processor for an unspecified reason.
S The CVN is on the card but was not included in the request.
U Card verification is not supported by the issuing bank.
X Card verification is not supported by the payment card company.
1 Card verification is not supported for this processor or card type.
2 An unrecognized result code was returned by the processor for the card
verification response.
3 No result code was returned by the processor.

Credit Card Services Using the Simple Order API | September 2019 479
 APPENDIX
CyberSource through
VisaNet Acquirers
K

The Visa Electron card type is processed the same way that the Visa debit card
is processed. Use card type value 001 (Visa) for Visa Electron.
Note

The following acquirers are supported for CyberSource through VisaNet:

 Absa Bank: Visa, Mastercard, JCB, Diners Club

 Agricultural Bank of China (ABC): Visa, Mastercard, American Express, JCB, Diners Club

CyberSource through VisaNet cannot process domestic transactions in

China. CyberSource through VisaNet can process only cross-border
Note transactions. A cross-border transaction is a transaction for which the
payment card is issued in another country and accepted by a merchant in
China.

 Ahli United Bank in Bahrain: Visa, Mastercard, JCB, Diners Club

 Arab African International Bank (AAIB): Visa, Mastercard, JCB

 Asia Commercial Bank (ACB): Visa, Mastercard, JCB

 Auckland Savings Bank (ASB): Visa, Mastercard

 Australia and New Zealand Banking Group Limited (ANZ): Visa, Mastercard

 Axis Bank Ltd. of India: Visa, Mastercard, Diners Club

 Banco Nacional de México (Banamex): Visa, Mastercard, American Express,

Discover, JCB, Diners Club

 Banco Safra: Visa, Mastercard, American Express

 Bangkok Bank Ltd.: Visa, Mastercard, JCB

 Bank Muscat of Oman: Visa, Mastercard, American Express, Diners Club

Credit Card Services Using the Simple Order API | September 2019 480
 Appendix K CyberSource through VisaNet Acquirers

 Bank of Ayudhya (BAY): Visa, Mastercard, JCB

 Bank of China (BOC): Visa, Mastercard

 Bank of Communications: Visa, Mastercard

CyberSource through VisaNet cannot process domestic transactions in

China. CyberSource through VisaNet can process only cross-border
Note transactions. A cross-border transaction is a transaction for which the
payment card is issued in another country and accepted by a merchant in
China.

 Bank Sinarmas (Omise Ltd.): Visa, Mastercard

 Banque Pour Le Commerce Exterieur Lao (BCEL): Visa, Mastercard, American

Express, JCB

 Barclays Bank Botswana: Visa, Mastercard, American Express

 Barclays Bank Mauritius Limited: Visa, Mastercard, American Express

 Barclays Bank of Ghana Limited, Barclays Bank of Tanzania Limited, and Barclays
Bank of Uganda Limited: Visa, Mastercard, American Express

 Barclays Bank of Kenya: Visa, Mastercard, American Express

 Barclays Bank of Zambia: Visa, Mastercard, American Express

 Barclays Bank Seychelles: Visa, Mastercard, American Express

 BC Card Co., Ltd.: Visa, Mastercard, American Express, JCB

 BLOM Bank: Visa, Mastercard

 Cathay United Bank (CUB): Visa, Mastercard, JCB

 Citibank Hongkong and Macau: Visa, Mastercard, Diners Club, JCB

 Citibank Malaysia: Visa, Mastercard

 Citibank Singapore Ltd.: Visa, Mastercard, JCB

 Commercial Bank of Qatar: Visa, Mastercard, American Express, JCB, Diners Club

 CrediMax (Bahrain): Visa, Mastercard, American Express, JCB, Diners Club

 CTBC Bank Ltd.: Visa, Mastercard, JCB

 First Data Merchant Solutions in Brunei: Visa, Mastercard, JCB

Credit Card Services Using the Simple Order API | September 2019 481
 Appendix K CyberSource through VisaNet Acquirers

 First Data Merchant Solutions in Hong Kong: Visa, Mastercard, JCB

 First Data Merchant Solutions in Malaysia: Visa, Mastercard, JCB

 First Data Merchant Solutions in Singapore: Visa, Mastercard, JCB

 FirstRand Bank: Visa, Mastercard, American Express, Diners Club

 Global Payments Asia Pacific: Visa, Mastercard, JCB

In India, the only supported card types are Visa and Mastercard. All three
card types (Visa, Mastercard, JCB) are supported in all other countries that
Note Global Payments Asia Pacific covers.

 Habib Bank Ltd. (HBL): Visa, Mastercard, American Express, JCB, Diners Club

 HDFC Bank Ltd. of India: Visa, Mastercard, Diners Club

 I&M Bank: Visa, Mastercard

 ICICI of India: Visa, Mastercard

 Korea Exchange Bank (KEB): Visa, Mastercard, JCB

CyberSource through VisaNet cannot process domestic transactions in

Korea. CyberSource through VisaNet can process only cross-border
Note transactions. A cross-border transaction is a transaction for which the
payment card is issued in another country and accepted by a merchant in
Korea.

 Mashreq: Visa, Mastercard, American Express, JCB, Diners Club

 Maybank: Visa, Mastercard, American Express, JCB

 National Bank of Abu Dhabi (NBAD): Visa, Mastercard, JCB, Diners Club

 National Bank of Kuwait (NBK): Visa, Mastercard, Diners Club

 National Commercial Bank (NCB): Visa, Mastercard, mada as described in "mada

Debit Cards," page 24

 Network International: Visa, Mastercard, American Express, JCB, Diners Club

 Overseas Chinese Banking Corp (OCBC): Visa, Mastercard

 Promerica in Honduras and Nicaragua: Visa, Mastercard

 PT Bank Negara Indonesia: Visa, Mastercard

Credit Card Services Using the Simple Order API | September 2019 482
 Appendix K CyberSource through VisaNet Acquirers

 Qatar National Bank (QNB Group): Visa, Mastercard, American Express, JCB,
Diners Club

 Sacombank: Visa, Mastercard, JCB

 Sumitomo Mitsui Card Co.: Visa

 Taishin Bank Ltd.: Visa, Mastercard, American Express, JCB

 United Overseas Bank (UOB) in Singapore and Vietnam: Visa, Mastercard, JCB

 United Overseas Bank (UOB) in Thailand: Visa, Mastercard

 Vantiv: Visa, Mastercard, American Express, Discover, JCB, Diners Club

 Vietcombank: Visa, Mastercard, American Express, JCB, Diners Club

 VietinBank: Visa, Mastercard, JCB, Diners Club

 Vietnam Technological and Commercial Joint-stock Bank: Visa, Mastercard, American

Express, JCB, Diners Club

 Visa Guatemala: Visa

 VisaNet Uruguay: Visa

 Westpac: Visa, Mastercard

 Wing Hang Bank: Visa, Mastercard

 Wing Lung Bank: Visa, Mastercard

Credit Card Services Using the Simple Order API | September 2019 483
 APPENDIX
Expert Monitoring Solutions
(EMS) Reason Codes
L

The following table describes the reason codes returned in positions 4 through 5 of the
ccAuthReply_emsTransactionRiskScore field. See "Mastercard Expert Monitoring
Solutions (EMS)," page 168.

Table 70 EMS Reason Codes

Reason Description
Code
01 Suspicious cross border activity
02 Suspicious transaction
03 High number of transactions
04 High number of transactions at an unattended terminal
05 Suspicious recent history of transactions
06 Suspicious activity and high number of transactions
07 Suspicious cardholder not present activity
08 Suspicious activity and low number of transactions
09 Suspicious service station activity
10 Suspicious online activity
11 High amount transaction or high cumulated amount recently spent
12 Suspicious gambling activity
13 Suspicious phone or mail order activity
14 Suspicious grocery store activity
15 High risk country
16 High amount, high number of transactions, and cross border
17 Suspicious activity including previous declined transactions
18 Suspicious airline activity
19 Score forced to be 001 because the transaction being scored was a 04xx
message
20 Not a financial transaction
21 Abnormal geographic activity
22 Abnormal, high frequency at the same MCC

Credit Card Services Using the Simple Order API | September 2019 484
 Appendix L Expert Monitoring Solutions (EMS) Reason Codes

Table 70 EMS Reason Codes (Continued)

Reason Description
Code
23 High amount recent ATM activity
24 Suspicious recent ATM activity or suspicious ATM activity following a recent
abnormal activity
25 Suspicious telecom activity
26 High number of international ATM transactions
27 High cumulated withdrawal amount on international ATM
28 High velocity of domestic ATM transactions
29 High risk MCC

Credit Card Services Using the Simple Order API | September 2019 485
 APPENDIX
Electronic Verification
Response Codes
M

See "Electronic Verification (EV)," page 94, for a list of the fields in which the Electronic
Verification response codes are returned. The following table describes the mapped
response codes.

Table 71 Electronic Verification Mapped Response Codes

Response Description
Code
F First name matches; last name does not match.
L Last name matches; first name does not match.
M First name and last name match.
N No, the data does not match.
P The processor did not return verification information.
R The system is unavailable, so retry.
S The verification service is not available.
U Verification information is not available.
Y Yes, the data matches.
1 Electronic verification did not generate a response.
2 The processor returned an unrecognized value.

Credit Card Services Using the Simple Order API | September 2019 486
 APPENDIX
Formats for Discretionary
Data
N

This appendix provides examples of the formats for discretionary data for specific
acquirers. In request messages, you can include discretionary data in the issuer_
additionalData field. In reply messages, discretionary data can be sent to you in the same
field.

CyberSource recommends that you contact your acquirer for information about
the formats to use.
Note

Example for Visa Guatemala

This example is for issuer-funded installment payments. Additional formats exist; the
issuers and acquirers work together to develop and reach consensus on the formats.

Example 96 Discretionary Data Format for Issuer-Funded Installment Payments

with Visa Guatemala

VC10000000050000

Table 72 Discretionary Data Format for Issuer-Funded Installment Payments with

Visa Guatemala

Position Number of Description

(Character Characters or Digits
or Digit #)
1-2 2 Prefix. Set this value to VC.
3-4 2 Total number of installments.
5-16 12 Total amount.

Credit Card Services Using the Simple Order API | September 2019 487
 Appendix N Formats for Discretionary Data

Example for VisaNet Uruguay

This example is for issuer-funded installment payments. Additional formats exist; the
issuers and acquirers work together to develop and reach consensus on the formats.

Example 97 Discretionary Data Format for Issuer-Funded Installment Payments

with VisaNet Uruguay

00612012345678910000000008160003359

Table 73 Discretionary Data Format for Issuer-Funded Installment Payments with

VisaNet Uruguay

Position Number of Description

(Character Characters
or Digit #) or Digits
1-2 2 Plan type. Set this value to 00. Specifies that the transaction
is an e-commerce transaction.
3 1 Grace period. Number of months that the issuer waits before
charging customers.
4-5 2 Total number of installments. Possible values: 00 through
99.
6 1 POS entry mode. Set this value to 0. Specifies that the
transaction is an e-commerce transaction.
7-15 9 Identity document number. Set this value to the number on
the customer’s identity document or leave it blank.
Format: right justified with 0 (zero) padding on the left.
16 1 Financial inclusion law indicator. Possible values:
 1: Law 17934
 2: Law 18099
 3: Asignaciones familiares (AFAM) (family allowance
program)
 4: Real state law
 5: Law 19210
17-28 12 Financial inclusion amount. This value is the amount the
bank returns to the customer.
29-35 7 Merchant-generated invoice number.

Credit Card Services Using the Simple Order API | September 2019 488
 APPENDIX
Frequently Asked Questions
O

What kind of bank account do I need to accept payment cards?

You need a merchant bank account that is configured to process card-not-present or mail
order/telephone order (MOTO) transactions. See "Acquiring (Merchant) Banks," page 28.

What types of payment cards can my customers use?

CyberSource can accept payments made with numerous types of payment cards,
including Visa, Mastercard, Discover, and American Express. In addition, CyberSource
can accept most offline debit cards, which are also known as check cards, many private
label cards, and Level II purchasing cards. Your payment processor can limit the types of
cards that you can accept. See "Payment Processors," page 32, or contact your
CyberSource account representative.

Do I need to sign agreements with the payment card companies?

Some payment card companies, such as American Express and Discover, require you to
sign agreements with them. For other card types, such as Visa and Mastercard, you can
usually sign a single contract with your acquiring bank or payment processor. Your
acquiring bank can help ensure that you sign all of the necessary agreements.

Can I use more than one payment processor or merchant account

provider?
Yes. CyberSource can provide you with multiple CyberSource merchant IDs and configure
each one to use a different payment processor or merchant account provider.

What happens when my customers commit fraud?

You could be liable for fraudulent transactions. When customers complain that you
charged their accounts improperly, you might be required to return their money at your
expense; this is known as a chargeback. If you receive a large number of chargebacks, or
if a large number of your customers commit fraud, your acquiring bank might raise your
fees or revoke your merchant bank account. Contact your CyberSource account
representative for information about CyberSource products that can help prevent fraud.

Credit Card Services Using the Simple Order API | September 2019 489
 Appendix O Frequently Asked Questions

When do authorizations expire?

Most authorizations expire within five to seven days, but the bank or company that issued
the card decides how long an authorization lasts.

When an authorization expires, will I be able to charge my customer?

Yes. CyberSource is not notified when an authorization expires, so it is possible to capture
an expired authorization. However, the capture might be downgraded, which would
increase your fees for the transaction. Additionally, the payment card company can decide
not to capture expired authorizations.

If you believe that an authorization expired, you can request a new authorization, then
capture the new authorization. However, the new authorization could be denied if the
customer’s credit limit has been exceeded, if the card has expired, or if the card has been
cancelled.

Can I reverse an authorization?

Yes. Some processors allow you to reverse an authorization, which releases the hold that
the authorization placed on the customer’s payment card funds. For the list of processors
that allow you to reverse an authorization, see "Reversing an Authorization," page 52.

If your processor does not support authorization reversals and you need to reverse an
authorization, contact the customer’s issuing bank or wait for the authorization to expire.

Can I cancel a capture or credit?

Yes. For some processors, you can use the void service to cancel a capture or credit that
you have previously requested. You must request the void before CyberSource submits
the capture or credit request to your payment processor. See "Voiding a Capture or
Credit," page 85.

How can I prevent my customers from clicking the “Buy” button more than
once?
Use one or more of these options:
 After a customer clicks the “Buy” button, send the customer to a new web page
 After a customer clicks the “Buy” button, hide or disable the button

The Support Center provides sample JavaScript code to disable the “Buy” button after a
customer clicks it. The code is available at:

http://www.cybersource.com/support_center/implementation/best_practices/
view.xml?page_id=415

Credit Card Services Using the Simple Order API | September 2019 490
 Appendix O Frequently Asked Questions

Can I change the company name and phone number that appears on my
customers’ payment card statements?
CyberSource permits you to change these values, which are called merchant descriptors,
when you use a payment processor that supports this feature. After your processor
configures the merchant descriptors for your account, you can choose which merchant
descriptor to use every time you request a transaction. You must also contact
CyberSource and your processor to specify default merchant descriptors for your account.
See "Merchant Descriptors," page 169.

When do my capture and credit transactions appear on my CyberSource

reports?
Capture and credit transactions usually appear on your reports two calendar days after
you request them. However, it might take longer for funds to be transferred.

When are funds transferred between my customer’s bank account and my

company’s bank account?
Funds are usually transferred within two to three days after you request a capture or
credit.

Credit Card Services Using the Simple Order API | September 2019 491
 APPENDIX
Ingenico ePayments Credit
Card Reversals
P

Ingenico ePayments was previously called Global Collect.

Note

Credit card reversals and requests for information, which are also called retrieval
requests, are business transactions initiated by your customers through their banks.

The information in this section is generally applicable to all card types and all operating
regions although certain details can vary.

Requests for Information

Credit card reversals and requests for information involve communication:
 Between your customer and the acquiring bank
 Between you and Ingenico ePayments
 Between Ingenico ePayments and the acquiring bank

The process is:

1 The acquiring bank notifies Ingenico ePayments of your customer’s request for
information.

2 Ingenico ePayments searches for refunds already processed for the transaction identified
by your customer.

3 Ingenico ePayments responds to the acquiring bank stating “already refunded.” Ingenico
ePayments does not take any further action because the information request has been
satisfied. Requests for information are not documented within any report.

Credit Card Services Using the Simple Order API | September 2019 492
 Appendix P Ingenico ePayments Credit Card Reversals

4 If Ingenico ePayments’s research determines that a refund for the inquiry has not been
initiated, Ingenico ePayments forwards the retrieval request to you. All requests received
before midnight PT (Pacific Time) are forwarded to you by 0800 PT by email with a
request for additional information. See "Request for Information Example," page 496.

5 A request for information is an impending chargeback. If Ingenico ePayments does not

receive your answer by midnight PT before the fifth day, your customer’s bank initiates a
chargeback.

When you receive a request for information, you must respond promptly and with as much
detail as possible:

1 Respond to your customer’s request for information:

 Address your email to [email protected].

 There is no standard format to follow. However, you should provide as much

information as you have. You should provide scanned copies of delivery receipts or
official banking information with bank letterheads, bank logos, or other official bank
insignia.

2 Ingenico ePayments forwards your response by email to the acquiring bank which then
communicates with your customer’s issuing bank.

3 If the information in the response is sufficient in the judgment of the issuing bank or
customer in accordance with Mastercard/Visa/American Express rules, the chargeback is
not executed. The dispute is dropped without further notification to the acquirer, Ingenico
ePayments, or you.

Chargebacks
If one of the following situations occurs, then the issuing bank sends a chargeback
(refund) to the customer’s card and debits your account.:
 You do not send your response in a timely manner
 The information does not satisfy the reasons defined by the card type
 Your customer submits a valid claim for refund

If the information you provided in response to the request for information is not satisfactory
or if your customer decides to charge the item back for any reason as defined by the
specific card types, the issuing bank executes a chargeback. This adverse movement of
funds is unavoidable, but can be reversed in some cases. See "Representments,"
page 494.

Credit Card Services Using the Simple Order API | September 2019 493
 Appendix P Ingenico ePayments Credit Card Reversals

If Ingenico ePayments receives a chargeback by 0800 PT, the amount of the chargeback
is deducted from your account the next business day and is reflected in:
 The Transaction Search in the Business Center
 The Payment Events Report for that processing day

The chargeback entry includes the reason code for the chargeback. The card types do not
circulate lists of reason codes to merchants. However, notable merchant banks freely
provide detailed explanations of chargeback reason codes on their web sites. This
document provides:
 "Chargeback Reason Codes for Visa," page 475
 "Chargeback Reason Codes for Mastercard," page 476

Additionally, you can search the Internet for these phrases:

 Mastercard chargeback reason code
 Visa chargeback reason code

Whenever you receive a chargeback, your account is debited by the full or partial
transaction amount associated with the chargeback. Chargebacks are deducted from the
funding you would normally receive.

Representments
When you or Ingenico ePayments disputes the legitimacy of a chargeback, a
representment case is initiated:

1 Ingenico ePayments automatically initiates a representment case if your customer initiates

a chargeback for a transaction that has already been refunded by you.

As in all representment cases, there is no assurance that the issuing bank will reverse the
chargeback even in the face of the evidence. However, the chances of success are
excellent. Submitting a representment case does not automatically result in the debiting of
your customer’s account and the crediting of yours.

2 If you want to challenge a chargeback, in other words represent it, then you must do so
very quickly. To optimize your chances for success, you must document your facts and
submit them to Ingenico ePayments in five or fewer days after receiving notification of the
chargeback.

Additionally, you can search the Internet for these phrases:

 fight chargebacks
 representment

Credit Card Services Using the Simple Order API | September 2019 494
 Appendix P Ingenico ePayments Credit Card Reversals

3 If your representment case is approved by your customer’s issuing bank, the bank notifies
you by refunding your account for amount of the chargeback. Although it is inconvenient,
the payment card companies and issuing banks do not provide any other method of
notification.

The notification appears as a chargeback withdrawal that is noted in the Payment Events
Report. This event generally takes place 11 to 15 business days after you submit the
representment case information to Ingenico ePayments. A chargeback withdrawal credits
the financial status and the subsequent funding event.

Credit Card Services Using the Simple Order API | September 2019 495
 Appendix P Ingenico ePayments Credit Card Reversals

Request for Information Example

This example illustrates an email you might receive from Ingenico ePayments requesting
information. In this example, the Xs represent values for the request.

Dear Sir/Madam,

With regards to the transactions below, we have been requested by the cardholders/
cardholders’ banks to provide photocopies of the transaction receipts.

Please reply within 5 days from the date of this e-mail with:

- legible copies of the transaction receipts;

- a manually imprinted & signed voucher in the case of a hand keyed transaction;
- signed delivery information;
- any other relevant documentation to support these charges;
- or any information regarding a possible refund;
- together with a copy of this e-mail.

Ingenico ePayments Call-ID : XXXXX

Bank Case ID : XXXXXXXXX

Credit Card Number : ***********XXXX

External Order Number : XXXXXXXXXXX

Merchant Reference :

Merchant Number : XXXXXXXXXXXX

Contract-ID : XXXX

Transaction history

Transaction Curr Amount Date

--------------------------------------------------------------

Original order amount USD XX.XX DD-MM-YYYY

--------------------------------------------------------------

Total USD XX.XX

Amount currently in question USD XX.XX

Credit Card Services Using the Simple Order API | September 2019 496
 Appendix P Ingenico ePayments Credit Card Reversals

Visa and Mastercard International Rules and Regulations specify that Ingenico
ePayments's bank must provide a copy of a sales voucher when requested by a
cardholder or bank. Under these regulations, failure to provide a fully legible transaction
receipt will result in the item being returned unpaid to you. In the event that this
transaction was hand keyed into your terminal, you must also supply us with a copy of
the manual imprinted voucher you took, to prove the presence of the card.

Remember to keep all original vouchers for 12 months as per your merchant
agreement.

Kind regards,

Dispute Management
Ingenico ePayments
P.O. Box 2001
2130 GE Hoofddorp
The Netherlands
Fax: +31 23 554 8663
Email: [email protected]

Credit Card Services Using the Simple Order API | September 2019 497
 APPENDIX
Network Transaction
Identifiers
Q

The network transaction identifier is returned in ccAuthReply_

paymentNetworkTransactionID in the authorization reply message.

CyberSource through VisaNet

For CyberSource through VisaNet, the following values are returned for each card type:

 American Express: American Express generates this value. It is included in all replies
from the American Express Global Network (AEGN).

 Mastercard: This value is the qualification information for the Mastercard Interchange
Compliance (MIC) program. It is used for all Mastercard responses coming from
Banknet through Visa to certified acquirers. Format:
Bits 1-4: Banknet date
Bits 5-7: Mastercard product ID. See "Mastercard Product IDs," page 501.
Bits 8-13: Banknet reference number generated by Mastercard for each transaction
Bits 14-15: Spaces

 Visa and Other Card Types: The payment card company generates this value. It is
unique for each original authorization and identifies a transaction throughout its life
cycle.

GPN
For GPN, the following values are returned for each card type:

 American Express: The payment card company generates this value. CyberSource
saves this value and sends it to the processor in all subsequent capture requests.

 Discover: The payment card company generates this value. CyberSource saves this
value and sends it to the processor in all subsequent requests for full authorization
reversals and captures.

Credit Card Services Using the Simple Order API | September 2019 498
 Appendix Q Network Transaction Identifiers

 Mastercard: The payment card company generates this value. CyberSource saves it
and sends it to the processor in all subsequent requests for full authorization reversals
and captures. Format:
Bits 1-9: Banknet reference number generated by Mastercard for each transaction
Bits 10-13: Banknet date
Bits 14-15: Spaces

 Visa: The payment card company generates this value. CyberSource saves it and
sends it to the processor in all subsequent requests for full authorization reversals and
captures.

 Other Card Types: Not used.

Credit Card Services Using the Simple Order API | September 2019 499
 APPENDIX
Product Codes
R

The following table lists the values you can use for the product code in the item_#_
productCode request field.

Table 74 Product Codes

Product Code Definition

adult_content Adult content.
coupon Coupon applied to the entire order.
default Default value for the product code. CyberSource uses
default when a request message does not include a
value for the product code.
electronic_good Electronic product other than software.
electronic_software Software distributed electronically rather than on disks or
other media.
gift_certificate Gift certificate.
handling_only Fee that you charge your customer to cover your
administrative selling costs.
service Service that you perform for your customer.
shipping_and_handling The shipping portion is the charge for shipping the product to
your customer. The handling portion is the fee you charge
your customer to cover your administrative selling costs.
shipping_only Charge for transporting tangible personal property from your
location to your customer. You must maintain documentation
that clearly establishes the location where the title to the
property passed from you to your customer.
subscription Subscription to a web site or other content.

Credit Card Services Using the Simple Order API | September 2019 500
 APPENDIX
Product IDs
S

The Visa or Mastercard product ID is returned in ccAuthReply_cardCategory in the

authorization reply message for all processors except CyberSource through VisaNet.
For CyberSource through VisaNet:

 The Visa product ID is returned in ccAuthReply_cardCategory in the authorization

reply message.

 The Mastercard product ID is returned in ccAuthReply_paymentNetwork

TransactionID in the authorization reply message.

For descriptions of the Visa product IDs, see the Product ID table on the Visa Request &
Response Codes web page:

https://developer.visa.com/guides/request_response_codes

Mastercard Product IDs

Mastercard can introduce new values for this field without advance notice. See
the Mastercard technical documentation for additional information.
Note CyberSource through VisaNet does not edit or validate field content.

Table 75 Mastercard Product IDs

Value Description Value Description

CBL Carte Blanche MOC Standard Maestro Social
DAG Gold Debit Mastercard Salary MPA Prepaid Mastercard Payroll Card
DAP Platinum Debit Mastercard Salary MPB Mastercard Preferred Business Card
DAS Standard Debit Mastercard Salary MPC Mastercard Professional Card
DCC Diners Club MPD Mastercard Flex Prepaid (Canada
only)
DOS Standard Debit Mastercard Social MPF Prepaid Mastercard Gift Card
JCB Japanese Credit Bureau MPG Prepaid Mastercard Consumer
Reloadable Card

Credit Card Services Using the Simple Order API | September 2019 501
 Appendix S Product IDs

Table 75 Mastercard Product IDs (Continued)

Value Description Value Description

MAB World Elite Mastercard for Business MPJ Prepaid Debit Mastercard Card Gold
MAC Mastercard Corporate World Elite MPK Prepaid Mastercard Government
Commercial Card
MAP Mastercard Commercial Payments MPL Platinum Mastercard Card
Account product
MAQ Mastercard Prepaid Commercial MPM Prepaid Mastercard Consumer
Payments Account Promotion Card
MAV Mastercard Activation Verification MPN Prepaid Mastercard Insurance Card
MBB Mastercard Prepaid Consumer MPO Prepaid Mastercard Other Card
MBC Mastercard Prepaid Voucher MPR Prepaid Mastercard Travel Card
MBD Deferred Debit Mastercard MPT Prepaid Mastercard Teen Card
BusinessCard
MBE Mastercard Electronic Business MPV Prepaid Mastercard Government
Card Benefit Card
MBP Mastercard Corporate Prepaid MPW Prepaid Mastercard Corporate Card
MBT Mastercard Corporate Prepaid MPX Prepaid Mastercard Flex Benefit
Travel Card
MCB Mastercard BusinessCard/ MPY Prepaid Mastercard Employee
Mastercard Corporate Card Incentive Card
MCC Mastercard Card MPZ Prepaid Mastercard Emergency
Assistance Card
MCE Mastercard Electronic Card MRB Prepaid Mastercard Electronic
BusinessCard
MCF Mastercard Electronic Fleet Card MRC Prepaid Mastercard Electronic Card
MCG Gold Mastercard Card MRG Prepaid Mastercard Card Outside
U.S.
MCM Mastercard Corporate Meeting Card MRH Mastercard Platinum Prepaid Travel
Card
MCO Mastercard Corporate MRJ Prepaid Mastercard Gold Card
MCP Mastercard Corporate Purchasing MRK Prepaid Mastercard Electronic
Card Commercial
MCS Mastercard Standard Card MRL Prepaid Mastercard Electronic
Commercial
MCW World Mastercard Card MRS Prepaid Mastercard ISIC Student
Card
MCX Mastercard Card MRW Prepaid Mastercard BusinessCard
(international use) Credit Outside U.S.
MDB Debit Mastercard BusinessCard MSI Maestro point-of-sale debit program
MDG Debit Gold Mastercard MTP Mastercard Platinum Prepaid Travel
Card

Credit Card Services Using the Simple Order API | September 2019 502
 Appendix S Product IDs

Table 75 Mastercard Product IDs (Continued)

Value Description Value Description

MDL Business Debit Other Embossed MUS Prepaid Mastercard Unembossed
U.S.
MDM Middle Market Fleet Card MWB World Mastercard for Business
MDN Middle Market Purchasing Card MWE Mastercard World Elite
MDO Debit Mastercard Other MWO Mastercard Corporate World
MDP Debit Mastercard Platinum PRO Proprietary Card
MDQ Middle Market Corporate Card PVL Private label card
MDS Debit Mastercard SAG Gold Mastercard Salary-Immediate
Debit
MDT Mastercard Business Debit SAL Standard Maestro Salary
MDW Mastercard Black Debit/World Elite SAP Platinum Mastercard Salary-
Debit Mastercard Immediate Debit
MEB Mastercard Executive BusinessCard SAS Standard Mastercard Salary-
Immediate Debit
MEC Mastercard Electronic Commercial SOS Standard Mastercard Social-
Immediate Debit
MEF Mastercard Electronic Payment SUR Prepaid Mastercard Unembossed
Account Outside U.S.
MEO Mastercard Corporate Executive TBE Business-Immediate Debit
Card
MET Titanium Debit Mastercard TCB Mastercard Business Card-
Immediate Debit
MGF Mastercard Government TCF Mastercard Fleet Card-Immediate
Commercial Card Debit
MHA Mastercard Healthcare Prepaid Non- TCO Mastercard Corporate-Immediate
tax Debit
MHB Mastercard HSA Substantiated TCP Mastercard Purchasing Card-
Immediate Debit
MHC Mastercard Healthcare Credit Non- TDN Middle Market Mastercard
substantiated Purchasing Card-Immediate Debit
MHH Mastercard HSA Non-substantiated TEB Mastercard Executive
BusinessCard-Immediate Debit
MIA Mastercard Unembossed Prepaid TEC Mastercard Electronic Commercial-
Student Card Immediate Debit
MIK Mastercard Electronic Consumer TEO Mastercard Corporate Executive
Prepaid Non U.S. Student Card Card-Immediate Debit
MIL Mastercard Unembossed Prepaid TLA Mastercard Central Travel Solutions
Non U.S. Student Card Air-Immediate Debit
MIP Mastercard Debit Prepaid Student TNF Mastercard Public Sector
Card Commercial Card-Immediate Debit

Credit Card Services Using the Simple Order API | September 2019 503
 Appendix S Product IDs

Table 75 Mastercard Product IDs (Continued)

Value Description Value Description

MLA Mastercard Central Travel Solutions TPB Mastercard Preferred Business
Air Card-Immediate Debit
MLC Mastercard Micro-Business Card TPC Mastercard Professional Card-
Immediate Debit
MLD Mastercard Distribution Card WDR World Debit Mastercard Rewards
MLL Mastercard Central Travel Solutions WMR World Mastercard Rewards
Land
MNF Mastercard Public Sector
Commercial Card

Credit Card Services Using the Simple Order API | September 2019 504
 APPENDIX
Visa Secure
Response Codes
T

The Visa Secure response code is returned in ccAuthReply_cavvResponseCode in the

reply message for an authorization request. See "Visa Secure," page 197, for a
description of Visa Secure.

Table 76 Visa Secure Response Codes

Response Description
Code
0 CAVV not validated because erroneous data was submitted.
1 CAVV failed validation and authentication.
2 CAVV passed validation and authentication.
3 CAVV passed the validation attempt.
4 CAVV failed the validation attempt.
6 CAVV not validated because the issuer does not participate.
7 CAVV failed the validation attempt and the issuer is available.
8 CAVV passed the validation attempt and the issuer is available.
9 CAVV failed the validation attempt and the issuer is not available.
A CAVV passed the validation attempt and the issuer is not available.
B CAVV passed the validation with information only; no liability shift.
C CAVV attempted but not validated; issuer did not return CAVV code.
D CAVV not validated or authenticated; issuer did not return CAVV code.
I Invalid security data.
U Issuer does not participate or 3-D secure data was not used.
99 An unknown value was returned from the processor.

Credit Card Services Using the Simple Order API | September 2019 505
 APPENDIX
Values for the Wallet Type
Field
U

The wallet type is sent in the wallet_type field in authorization requests and credit
requests. Possible value are:

 101: Masterpass remote payment. The customer created the wallet by manually
interacting with a customer-controlled device such as a computer, tablet, or phone.
This value is supported only for Masterpass transactions on Chase Paymentech
Solutions and CyberSource through VisaNet.

 102: Masterpass remote near field communication (NFC) payment. The customer
created the wallet by tapping a PayPass card or customer-controlled device at a
contactless card reader. This value is supported only for card-present Masterpass
transactions on CyberSource through VisaNet.

 103: Masterpass Apple Pay payment. The payment was made with a combination of
Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay
transactions on CyberSource through VisaNet. See Apple Pay Using the Simple
Order API.

 216: Masterpass Google Pay payment. The payment was made with a combination of
Masterpass and Google Pay. This value is supported only for Masterpass Google Pay
transactions on CyberSource through VisaNet. See Google Pay Using the Simple
Order API.

 217: Masterpass Samsung Pay payment. The payment was made with a combination
of Masterpass and Samsung Pay. This value is supported only for Masterpass
Samsung Pay transactions on CyberSource through VisaNet. See Samsung Pay
Using the Simple Order API.

 SDW: Staged digital wallet. An issuer or operator created the wallet. This value is
supported only for Masterpass transactions on Chase Paymentech Solutions.

 VCIND: Visa Checkout or Visa Secure Remote Commerce payment. This value is
supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville
Global, FDI Australia, and TSYS Acquiring Solutions. See the Visa Checkout and Visa
Secure Remote Commerce web page.

For additional information about the wallet_type field, see Appendix A, "API Fields," on
page 240.

Credit Card Services Using the Simple Order API | September 2019 506
 INDEX
Index

AB C D E F G H I J K L M N O P Q R S T U V W X Y Z

A AIBMS
authorizations 38
AAV 189
AVS 88
AAV+ 93 captures 61
account authentication values 189 card types 33
account balances 111 credits 78
CVNs 97
acquirers 32
forced captures 142
acquiring banks 28 full authorization reversals 53
additional amounts 116 Mastercard Identity Check 189
Address Verification System merchant-initiated transactions 173
AAV+ 93 multiple partial captures 71
codes 468 recurring payments 207
described 88 subsequent authorizations 173
Enhanced 93 verbal authorizations 101
and recurring payments 214 Visa Secure 197
relaxed requirements 91 voids 85
zero amount authorizations 231
aggregator 117
airline data 126
aggregator support 117
American Express
payment card company 29
SafeKey response codes 467
SafeKey, described 186
American Express Brighton
authorizations 38
AVS 88
captures 61
card types 33
credits 78
CVNs 97
recurring payments 207
verbal authorizations 101
voids 85

Credit Card Services Using the Simple Order API | September 2019 507
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

American Express Direct Asia, Middle East, and Africa Gateway

AAV+ 93 authorizations 38
additional amounts 116 automatic captures 40
aggregators 118 captures 61
American Express SafeKey 187 card types 33
ARAV 59 credits 78
authorization only 127 CVNs 97
authorizations 38 examples, name-value pairs 406
AVS 88 examples, XML 431
AVS, enhanced 93 forced captures 142
balance responses 112 Mastercard Identity Check 189
captures 61 multiple partial captures 71
card types 33 recurring payments 207
credits 78 verbal authorizations 101
CVNs 97 Visa Secure 197
Electronic Verification 94 voids 85
forced captures 142 Atos
full authorization reversals 53 authorization refresh 68
installment payments 145 authorizations 38
multiple partial captures 71 AVS 88
partial authorizations 106 captures 61
recurring payments 207 card types 33
verbal authorizations 101 credits 78
voids 85 CVN 97
zero amount authorizations 231 Mastercard Identity Check 189
Android Pay 126 quasi-cash 205
Apple Pay 126 recurring payments 207
Visa Secure 197
ARAV 59
authorization only 127
authorization refresh 68
authorization reversals
after void (ARAV) 59
alternate methods 490
full 52
partial 69

Credit Card Services Using the Simple Order API | September 2019 508
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

authorizations B
checking status of 44
credits for 84 balance inquiries 128
described 38 balance responses 111
examples, name-value pairs 403 Barclays
examples, XML 428 ARAV 59
expiration of 490 authorizations 38
for zero amounts 231 automatic authorization reversals 69
partial 105 AVS 88
verbal 101 captures 61
See also ccAuthService card types 33
authorizations, incremental 45 cash advances 132
automatic authorization reversals 69 credits 78
CVNs 97
automatic captures 40
final authorization indicator 138
automatic interchange optimization 70 full authorization reversals 53
AVS Mastercard Identity Check 189
AAV+ 93 merchant-initiated transactions 173
codes 468 multiple partial captures 71
described 88 recipients 206
Enhanced 93 recurring payments 208
and recurring payments 214 subsequent authorizations 173
relaxed requirements 91 verbal authorizations 101
AVS only 231 Visa Secure 197
voids 85
zero amount authorizations 231
Bill Payment program
Mastercard 167
Visa 229
BNDES 129
bundled requests 40
business cards 167
business rules 92

Credit Card Services Using the Simple Order API | September 2019 509
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

C ccAuthService
described 38
captures requesting 41
after void 86 required fields 42
automatic 40
ccCaptureService
described 61
described 61
examples, name-value pairs 403
requesting 62
examples, XML 428
required fields 63
multiple 71
partial 71 ccCheckStatusService
See also ccCaptureService required fields 44
standard 40 ccCreditService
card associations 29 described 78
requesting 79
card identification digits. See CVNs
required fields 80
card type indicators 130
characters
card validation codes. See CVNs
multibyte 240
card verification numbers. See CVNs special 240
cardholder authentication verification values chargebacks
API fields 273 described 29
for American Express SafeKey 188, 196 fees 28
for JCB J/Secure 199 for Ingenico ePayments 492
for ProtectBuy 199 reason codes for Mastercard 476
for Visa Secure 199 reason codes for Visa 475
Cardnet. See LloydsTSB Cardnet Chase Pay 132
card-not-present transactions 26
card-on-file transactions 173
card-present data 130
card-present transactions 26
Carte Bancaire 21
cash advances 132
CAVV
API fields 273
for American Express SafeKey 188, 196
for JCB J/Secure 199
for ProtectBuy 199
for Visa Secure 199
ccAuthReversalService
described 52
requesting 57
required fields 58

Credit Card Services Using the Simple Order API | September 2019 510
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Chase Paymentech Solutions Cielo

ARAV 59 authorizations 38
authorizations 38 automatic captures 40
automatic authorization reversals 69 AVS 89
AVS 88 captures 61
balance responses 112 card types 33
captures 61 credits 78
card type indicators (CTIs) 130 CVNs 97
card types 33 examples, name-value pairs 407
credits 78 examples, XML 433
CVNs 97 full authorization reversals 53
encoded account numbers 137 installment payments 145
final authorization indicator 138 Mastercard Identity Check 189
forced captures 142 recurring payments 208
full authorization reversals 53 Visa Secure 197
installment payments 145 voids 85
Mastercard Identity Check 189 Citibank India 33
Masterpass 169
co-badged cards
merchant-initiated reversals 170
Carte Bancaire 21
merchant-initiated transactions 173
mada 24
multi-currency 185
multiple partial captures 71 Comercio Latino
partial authorizations 106 ARAV 59
recurring payments 208 authorizations 38
subsequent authorizations 173 automatic captures 40
verbal authorizations 102 AVS 89
Visa Bill Payments 229 captures 61
Visa Secure 197 card types 34
voids 85 credits 78
zero amount authorizations 231 CVNs 97
full authorization reversals 53
China processing 36
installment payments 145
China UnionPay, alliance with Discover 23 Mastercard Identity Check 189
CID. See CVNs recurring payments 208
Visa Secure 197
voids 85
commerce indicators
API fields 274
for American Express SafeKey 188, 196
for JCB J/Secure 200
for Mastercard Identity Check 192
for ProtectBuy 200
for Visa Secure 200
values 477

Credit Card Services Using the Simple Order API | September 2019 511
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

consumer banks 29 CyberSource through VisaNet

corporate cards 167 aggregators 121
American Express SafeKey 187
credentials-on-file transactions 173
ARAV 59
credit card associations 29 automatic ARAV 60
credit card encryption 137 automatic authorization reversals 69
credit card numbers for testing 238 AVS 90
balance inquiries 128
Credit Mutuel-CIC
balance responses 112
ARAV 59
BNDES 129
authorizations 38
card types 34
automatic ARAV 60
co-badged cards 24
automatic authorization reversals 69
credit authorizations 84
AVS 89
credits 78
captures 61
CVNs 97
card types 34
Carte Bancaire 21 final authorization indicator 138
co-badged cards 21 forced captures 143
full authorization reversals 54
credits 78
CVNs 97 full-financial transactions 76
full authorization reversals 53 incremental authorizations 45
installment payments 146
Mastercard Identity Check 189
recurring payments 208 interchange optimization 70
Visa Secure 197 Japanese payment options 162
JCB J/Secure 188
voids 85
zero amount authorizations 231 mada cards 24
Mastercard Bill Payments 167
credits
Mastercard Expert Monitoring Solutions
described 78
(EMS) 168
for authorizations 84
Mastercard Identity Check 1.0 189
See also ccCreditService
Mastercard Identity Check 2.0 190
CTIs 130 Masterpass 169
customer profiles 228 merchant-initiated reversals 170
CVC2. See CVNs merchant-initiated transactions 173
multiple partial captures 71
CVNs
partial authorizations 106
and recurring payments 207
recurring payments 209
codes 479
single-message processing 76
described 97
split shipments 220
CVV2. See CVNs subsequent authorizations 173
CyberSource Latin American Processing. See verbal authorizations 102
Latin American Processing Visa Debt Repayments 230
Visa Secure 197
zero amount authorizations 232

Credit Card Services Using the Simple Order API | September 2019 512
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

D Elavon Americas
American Express SafeKey 187
data types 241 authorization only 127
date and time formats 365 automatic authorization reversals 69
DCC 133 AVS 90
debit cards 22 balance inquiries 128
balance responses 112
Debt Repayment program (Visa) 230
captures 61
digital wallets 506 card types 34
Diners Club credits 78
acquisition by Discover 23 CVNs 98
ProtectBuy 186 final authorization indicator 138
Discover forced captures 143
acquisitions and alliances 23 full authorization reversals 54
payment card company 29 JCB J/Secure 188
ProtectBuy 186 Mastercard Identity Check 189
Masterpass 169
dynamic currency conversion (DCC) 133
merchant-initiated reversals 170
merchant-initiated transactions 173
E multiple partial captures 71
E4X 185 partial authorizations 106
recurring payments 210
ECI
subsequent authorizations 173
API fields 274
verbal authorizations 102
for American Express SafeKey 188, 196
Visa Secure 197
for JCB J/Secure 200
voids 85
for Mastercard Identity Check 192
zero amount authorizations 232
for ProtectBuy 200
for Visa Secure 200 electronic commerce indicators
values 477 API fields 274
Elavon for American Express SafeKey 188, 196
for JCB J/Secure 200
AVS 90
card types 34 for Mastercard Identity Check 192
credits 78 for ProtectBuy 200
for Visa Secure 200
CVNs 98
final authorization indicator 138 values 477
full authorization reversals 54 Electronic Verification
Mastercard Identity Check 189 described 94
multiple partial captures 71 response codes 486
recipients 206 EMS 168
recurring payments 210 encoded account numbers 137
verbal authorizations 102
encryption 137
Visa Secure 197
zero amount authorizations 232 Enhanced AVS 93

Credit Card Services Using the Simple Order API | September 2019 513
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

errors, simulating during testing 239 FDC Germany

EV ARAV 59
described 94 authorizations 38
response codes 486 AVS 90
captures 61
example code 403
card types 34
exchange rates 185 credits 78
Expert Monitoring Solutions (EMS) 168 CVNs 98
expiration dates full authorization reversals 54
for recurring payments 207 Mastercard Identity Check 189
relaxed requirements 91 recurring payments 210
verbal authorizations 102
expiration of authorizations 490
Visa Secure 197
voids 85
F
FAQ 489
FDC Compass
aggregators 124
ARAV 59
authorizations 38
automatic authorization reversals 69
AVS 90
balance responses 112
captures 61
card types 34
credits 78
CVNs 98
final authorization indicator 138
full authorization reversals 54
installment payments 147
Mastercard Identity Check 189
merchant-initiated transactions 174
multiple partial captures 71
partial authorizations 106
recurring payments 210
subsequent authorizations 174
verbal authorizations 102
Visa Bill Payments 229
Visa Secure 197
voids 85
zero amount authorizations 232

Credit Card Services Using the Simple Order API | September 2019 514
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

FDC Nashville Global FDI Australia

aggregators 125 authorizations 38
American Express SafeKey 187 captures 61
ARAV 59 card types 35
authorizations 38 credits 78
automatic authorization reversals 69 CVNs 98
AVS 90 final authorization indicator 138
balance responses 113 full authorization reversals 54
captures 61 installment payments 147
card types 35 least-cost routing 164
credits 78 Mastercard Identity Check 189
CVNs 98 recurring payments 210
dynamic currency conversion (DCC) 133 verbal authorizations 102
Electronic Verification 94 Visa Secure 197
final authorization indicator 138 voids 85
forced captures 143 zero amount authorizations 233
full authorization reversals 54 FDMS Nashville
installment payments 147 ARAV 59
Mastercard Identity Check 1.0 189 authorizations 38
Mastercard Identity Check 2.0 190 automatic authorization reversals 69
merchant-initiated reversals 170 AVS 90
merchant-initiated transactions 174 balance responses 113
multiple partial captures 71 captures 61
partial authorizations 106 card types 35
recurring payments 210 credits 78
subsequent authorizations 174 CVNs 98
verbal authorizations 102 final authorization indicator 138
Visa Bill Payments 229 forced captures 143
Visa Debt Repayments 230 full authorization reversals 55
Visa Secure 197 installment payments 147
voids 85 Mastercard Identity Check 189
zero amount authorizations 233 multiple partial captures 71
partial authorizations 106
recurring payments 211
verbal authorizations 102
Visa Bill Payments 229
Visa Debt Repayments 230
Visa Secure 197
voids 85
zero amount authorizations 233

Credit Card Services Using the Simple Order API | September 2019 515
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

FDMS South Global Collect. See Ingenico ePayments

ARAV 59 GMT 365
authorizations 38
Google Pay 144
automatic authorization reversals 69
AVS 90 GPN
balance responses 113 ARAV 59
captures 61 authorizations 38
card types 35 automatic authorization reversals 69
credits 78 AVS 90
CVNs 98 balance responses 113
forced captures 143 captures 61
full authorization reversals 55 card types 35
installment payments 147 credits 78
Mastercard Identity Check 189 CVNs 98
partial authorizations 106 final authorization indicator 138
recurring payments 211 forced captures 143
verbal authorizations 102 full authorization reversals 55
Visa Secure 197 interchange optimization 70
voids 85 Mastercard Identity Check 189
zero amount authorizations 233 merchant-initiated transactions 174
partial authorizations 106
follow-on credits 79
product IDs 501
forced captures 142 quasi-cash 205
foreign exchange service 185 recurring payments 211
fraud 489 split shipments 220
subsequent authorizations 174
full authorization reversals
verbal authorizations 102
described 52
Visa Bill Payments 229
See also ccAuthReversalService
Visa Debt Repayments 230
full-financial transactions 76 Visa Secure 197
voids 85
G zero amount authorizations 233
Getnet guaranteed exchange rates 185
authorizations 38
captures 61
card types 35
credits 78
full authorization reversals 55
installment payments 147
Mastercard Identity Check 189
Masterpass 169
Visa Secure 197
voids 85
zero amount authorizations 233

Credit Card Services Using the Simple Order API | September 2019 516
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

H I
HBoS Identity Check 186
ARAV 59 incremental authorizations 45
authorizations 38
Ingenico ePayments
AVS 90
authorizations 38
captures 61
captures 61
card types 35
card types 35
credits 78
chargebacks 492
CVNs 98
credits 78
final authorization indicator 138
CVNs 98
full authorization reversals 55
JCB J/Secure 188
Mastercard Identity Check 189
Mastercard Identity Check 189
merchant-initiated transactions 174
recurring payments 211
recipients 206
representments 494
recurring payments 211
requests for information 492
subsequent authorizations 174
retrieval requests 492
verbal authorizations 102
transaction reversals 492
Visa Secure 197
Visa Secure 197
voids 85
zero amount authorizations 234 installment payments 145

HSBC interchange fees 28

ARAV 59 interchange optimization 70
authorizations 38 issuer encryption 137
AVS 90 issuing banks 29
captures 61
card types 35
credits 78
J
CVNs 98 J/Secure 186
final authorization indicator 138 Japanese payment options 162
full authorization reversals 55
JCB
Mastercard Identity Check 189
alliance with Discover 23
merchant-initiated transactions 174
J/Secure 186
multiple partial captures 71
recurring payments 211
subsequent authorizations 174
verbal authorizations 102
Visa Secure 197
voids 85
zero amount authorizations 234

Credit Card Services Using the Simple Order API | September 2019 517
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

JCN Gateway Lloyds-OmniPay

American Express SafeKey 187 ARAV 59
card types 35 authorizations 38
credits 78 AVS 90
CVNs 98 captures 61
forced captures 143 card types 36
full authorization reversals 56 credits 78
Japanese payment options 162 CVNs 98
JCB J/Secure 188 final authorization indicator 138
Mastercard Identity Check 189 full authorization reversals 56
multiple partial captures 71 merchant-initiated transactions 174
verbal authorizations 102 recurring payments 211
Visa Secure 197 subsequent authorizations 174
zero amount authorizations 234 verbal authorizations 102
voids 85
L zero amount authorizations 234
LloydsTSB Cardnet
Latin American Processing
ARAV 59
authorizations 38
authorizations 38
automatic captures 40
AVS 91
AVS 89
captures 61
captures 61
card types 36
card types 34
cash advances 132
credits 78
credits 78
CVNs 97
CVNs 98
examples, name-value pairs 410
final authorization indicator 138
examples, XML 439
full authorization reversals 56
installment payments 145
Mastercard Identity Check 189
Mastercard Identity Check 189
merchant-initiated transactions 174
Visa Secure 197
multiple partial captures 71
voids 85
recipients 206
least-cost routing 164 recurring payments 211
Level II 167 subsequent authorizations 174
Level III 167 verbal authorizations 102
Visa Secure 198
voids 85
zero amount authorizations 234

Credit Card Services Using the Simple Order API | September 2019 518
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Lynk Moneris
authorizations 38 authorizations 38
AVS 91 AVS 91
captures 61 captures 61
card types 36 card types 36
credits 78 credits 78
CVNs 98 CVNs 98
verbal authorizations 102 full authorization reversals 56
Mastercard Identity Check 189
M recurring payments 211
verbal authorizations 102
mada cards 24 Visa Secure 198
Maestro (UK Domestic) cards 115 voids 85
Mastercard zero amount authorizations 234
Bill Payment program 167 multibyte characters 240
BIN range 25 multi-currency 185
Expert Monitoring Solutions (EMS) 168
multiple captures 71
Identity Check 186
Masterpass 506
payment card company 29 N
Paypass 506 network tokenization 204
Masterpass network transaction identifiers 498
described 169
values for wallet_type field 506
merchant banks 28
merchant-initiated reversals 170
merchant-initiated transactions 173
merchant-initiated voids 170
micropayments 185

Credit Card Services Using the Simple Order API | September 2019 519
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

O OmniPay-Ireland
authorizations 38
OmniPay. See Lloyds-OmniPay automatic authorization reversals 69
OmniPay Direct AVS 91
ARAV 60 captures 61
authorizations 38 card types 36
automatic authorization reversals 69 credits 78
AVS 91 CVNs 99
captures 61 final authorization indicator 138
card types 36 installment payments 147
credits 78 Mastercard Identity Check 190
CVNs 99 multiple partial captures 71
final authorization indicator 138 recurring payments 211
forced captures 143 verbal authorizations 102
full authorization reversals 56 Visa Bill Payments 229
Mastercard Identity Check 1.0 190 Visa Secure 198
Mastercard Identity Check 2.0 190 voids 85
Masterpass 169 zero amount authorizations 235
merchant-initiated reversals 170 open to buy 38
merchant-initiated transactions 174
order tracking 30
multiple partial captures 71
recurring payments 211
subsequent authorizations 174 P
verbal authorizations 102 partial authorization reversals 69
Visa Secure 198
partial authorizations
voids 85
described 105
zero amount authorizations 235
examples, name-value pairs 412
examples, XML 441
partial captures 71
partial shipments
described 220
examples, name-value pairs 417
examples, XML 447
PayEase China Processing 36
payer authentication 186
payment aggregator 117
payment card companies 29
payment card numbers for testing 238
payment network tokenization 204
payment network transaction identifiers 498
payment processors 32

Credit Card Services Using the Simple Order API | September 2019 520
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

payment tokenization 228 recurring indicators 207

Paymentech. See Chase Paymentech Solutions recurring payments 207
PayPass 506 recurring profiles 207
PaySecure 186 recurring transactions 207
PIN debit cards 22 Rede
PINless debit cards 22 authorizations 38
captures 61
POS transactions 130
card types 36
prepaid cards 105 credits 78
private label cards 21 full authorization reversals 56
processors 32 installment payments 148
Mastercard Identity Check 190
procurement cards 167
Masterpass 169
product codes 500
merchant-initiated reversals 170
product IDs 501 merchant-initiated transactions 174
profiles 228 recurring payments 211
ProtectBuy 186 subsequent authorizations 174
Visa Secure 198
purchasing cards 167
voids 85
zero amount authorizations 235
Q
refunds
quasi-cash 205 described 78
See also ccCreditService
R relaxed requirements 91
RBS WorldPay Atlanta Repayment program (Visa) 230
authorizations 38 replacement dates for recurring payments 207
AVS 91 report groups 217
captures 61
representments 494
card types 36
credits 78 request fields 243
CVNs 99 request IDs 30
full authorization reversals 56 requests for information 492
Mastercard Identity Check 190 retail POS transactions 130
recurring payments 211
retrieval requests 492
verbal authorizations 102
Visa Secure 198 reversals, authorization
voids 85 alternate methods 490
zero amount authorizations 235 full 52
partial 69
recipients 206
reconciliation IDs 30 reversals, merchant-initiated 170

recurring billing 207

Credit Card Services Using the Simple Order API | September 2019 521
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

reversals, transaction SIX

described 29 ARAV 60
fees 28 authorizations 38
for Ingenico ePayments 492 automatic ARAV 60
reason codes for Mastercard 476 AVS 91
reason codes for Visa 475 captures 61
RuPay card types 36
authorizations 38 credits 78
captures 61 CVNs 99
card types 36 dynamic currency conversion (DCC) 133
checking status 44 final authorization indicator 138
credits 78 full authorization reversals 57
CVNs 99 JCB J/Secure 188
examples, name-value pairs 416 Mastercard Identity Check 190
examples, XML 445 Masterpass 169
full-financial transactions 76 merchant-initiated reversals 170
PaySecure 186 merchant-initiated transactions 175
single-message processing 76 ProtectBuy 195
voids 85 recurring payments 212
subsequent authorizations 175
Visa Secure 198
S
voids 85
SafeKey zero amount authorizations 235
described 186 Software Express
response codes 467 authorizations 38
sample code 403 captures 61
Saudi Arabia Monetary Authority (SAMA) 24 card types 36
credits 78
secure data 228
full authorization reversals 57
secure storage 228
installment payments 148
service fees 219 voids 85
settlements. See captures and credits special characters 240
single-message processing 76 split dial/route 142
split shipments
described 220
examples, name-value pairs 417
examples. XML 447
staged digital wallet 226
stand-alone credits 79

Credit Card Services Using the Simple Order API | September 2019 522
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Streamline transaction reversals

ARAV 60 described 29
authorizations 38 fees 28
AVS 91 for authorizations 52
captures 61 for Ingenico ePayments 492
card types 37 reason codes for Mastercard 476
credits 78 reason codes for Visa 475
CVNs 99 TSYS Acquiring Solutions
final authorization indicator 139 ARAV 60
full authorization reversals 57 authorizations 38
Mastercard Identity Check 190 automatic authorization reversals 69
merchant-initiated transactions 175 AVS 91
multiple partial captures 72 balance responses 113
recipients 206 captures 61
recurring payments 212 card types 37
subsequent authorizations 175 credits 78
Visa Secure 198 CVNs 99
voids 85 Electronic Verification 94
zero amount authorizations 236 final authorization indicator 139
subscriptions 207 forced captures 143
subsequent authorizations 173 full authorization reversals 57
installment payments 148
Switch cards 115
JCB J/Secure 188
Mastercard Identity Check 190
T multiple partial captures 72
testing your system 237 partial authorizations 106
quasi-cash 205
time formats 365
recurring payments 212
TMS 228 verbal authorizations 102
Token Management Service 228 Visa Bill Payments 229
tokenization Visa Secure 198
payment network tokenization 204 voids 85
Token Management Service 228 zero amount authorizations 236
transaction identifiers Type II cards 167
API field 284
for American Express SafeKey 188, 196
for JCB J/Secure 203
for Mastercard Identity Check 195
for ProtectBuy 203
for Visa Secure 203

Credit Card Services Using the Simple Order API | September 2019 523
 Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

U W
UATP wallets 506
authorizations 38 Worldpay VAP
captures 61 ARAV 60
card types 37 authorizations 38
credits 78 AVS 91
verbal authorizations 102 balance responses 114
voids 85 captures 61
UCAF card type indicators (CTIs) 130
API fields 358 card types 37
for Mastercard Identity Check 194 credits 78
universal cardholder authentication fields CVNs 99
API fields 358 Electronic Verification 94
for Mastercard Identity Check 194 final authorization indicator 139
full authorization reversals 57
UTC (in authorization reply) 365
installment payments 148
least-cost routing 164
V Mastercard Identity Check 190
verbal authorizations 101 multiple partial captures 72
partial authorizations 106
Visa
recurring payments 212
Bill Payment program 229
report groups 217
Debt Repayments 230
verbal authorizations 102
payment card company 29
Visa Secure 198
Visa Secure response codes 505
voids 85
Visa Secure, described 186
zero amount authorizations 236
Visa Checkout 229
Visa Secure X
described 186
response codes 505 XID
Visa Secure Remote Commerce 229 API field 284
for American Express SafeKey 188, 196
Vital. See TSYS Acquiring Solutions
for JCB J/Secure 203
voids, merchant-initiated 170 for Mastercard Identity Check 195
voidService for ProtectBuy 203
described 85 for Visa Secure 203
requesting 86
required fields 87 Z
zero amount authorizations 231

Credit Card Services Using the Simple Order API | September 2019 524