Payments Developer Guide

This section describes how to use this guide and where to find further information.

Audience and Purpose: This guide is written for application developers who want to use the Simple Order API to integrate payment card processing into an order management system.

Implementing the Cybersource payment services requires software development skills. You must write code that uses the API request and response fields to integrate the payment card services into your existing order management system.
Conventions: These statements appear in this document:
An Important
statement contains information essential to successfully completing a task or learning a concept.

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 or both.

Related Documentation: Visit the Cybersource documentation hub to find additional processor-specific versions of this guide and additional technical documentation.

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

Recent Revisions to This Document

25.09.02

Micropayments: Added micropayments. See Micropayments.

This revision contains only editorial changes and no technical updates.

25.09.01

This revision contains only editorial changes and no technical updates.

25.08.01

This revision contains only editorial changes and no technical updates.

25.07.01

PayPak Cards: Added PayPak cards. See Card Types.

25.05.01

International Transaction Compliance: Added a section about international transaction compliance. See Compliance.

25.04.01

This revision contains only editorial changes and no technical updates.

25.03

This revision contains only editorial changes and no technical updates.

25.02

Incremental Authorizations: Added an optional field. See Optional Field for Processing an Incremental Authorization.

25.01

Added a testing section. See Testing the Payment Services.

Marketplace Transactions with Foreign Retailers: Added authorizations and captures. See these sections:
Marketplace Authorizations with Foreign Retailers
Marketplace Captures with Foreign Retailers
Credentialed Transactions: Removed Mastercard required field for retrieving customer credentials during a CIT request. See Card-Specific Required Field for Retrieving Customer Credentials During a CIT.; Added new country-specific fields for requesting a subsequent installment payment. See Country-Specific Required Fields for Installment Payments with Mastercard or Visa Card.

24.14

This revision contains only editorial changes and no technical updates.

24.13

This revision contains only editorial changes and no technical updates.

24.12

This revision contains only editorial changes and no technical updates.

24.11

This revision contains only editorial changes and no technical updates.

24.10

This revision contains only editorial changes and no technical updates.

24.09

This revision contains only editorial changes and no technical updates.

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

The following are specifications and conditions that apply to a Reseller/Partner enabling its merchants through

Cybersource for

Visa Platform Connect

(“VPC”) processing

. Failure to meet any of the specifications and conditions below is subject to the liability provisions and indemnification obligations under Reseller/Partner’s contract with Visa/Cybersource.

Before boarding merchants for payment processing on a VPC acquirer’s connection, Reseller/Partner and the VPC acquirer must have a contract or other legal agreement that permits Reseller/Partner to enable its merchants to process payments with the acquirer through the dedicated VPC connection and/or traditional connection with such VPC acquirer.

Reseller/Partner is responsible for boarding and enabling its merchants in accordance with the terms of the contract or other legal agreement with the relevant VPC acquirer.

Reseller/Partner acknowledges and agrees that all considerations and fees associated with chargebacks, interchange downgrades, settlement issues, funding delays, and other processing related activities are strictly between Reseller and the relevant VPC acquirer.

Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is responsible for payment processing issues, including but not limited to, transaction declines by network/issuer, decline rates, and interchange qualification, as may be agreed to or outlined in the contract or other legal agreement between Reseller/Partner and such VPC acquirer.

DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR OMISSIONS BY THE

Visa Platform Connect

ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE RELEVANT

Visa Platform Connect

ACQUIRER.

Introduction to Payments

This introduction provides the basic information that you need to successfully process payment transactions. It also provides an overview of the payments industry and provides workflows for each process.

With Cybersource payment services, you can process payment cards (tokenized or non-tokenized), digital payments such as Apple Pay and Google Pay, and customer ID transactions. You can process payments across the globe and across multiple channels with scalability and security. Cybersource supports a large number of payment cards and offers a wide choice of gateways and financial institutions, all through one connection.

Visit the Cybersource documentation hub to find additional processor-specific versions of this guide and additional technical documentation.

Financial Institutions and Payment Networks

Financial institutions and payment networks enable payment services to function. These entities work together to complete the full payment cycle.

Merchant Financial Institutions (Acquirers)

A merchant financial institution, also known as an acquirer
, offers accounts to businesses that accept payment cards. Before you can accept payments, you must have a merchant account from an acquirer. Your merchant account must be configured to process card-not-present, card-present, or mail-order/telephone-order (MOTO) transactions.

Each acquirer has connections to a limited number of payment processors. You must choose a payment processor that your acquirer supports.

You can expect your acquirer to charge these fees:

Discount rates: your acquirer 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).

Interchange fees: payment networks, such as Visa or Mastercard, each have a base fee, called the interchange fee
, for each type of transaction. Your acquirer and processor can show you ways to reduce this fee.

Chargebacks: when cardholders dispute charges, you can incur chargebacks
. A chargeback occurs when a charge on a customer’s account is reversed. Your acquirer removes the money from your account and could charge you a fee for processing the chargeback.

Take these precautions to prevent chargebacks:

Use accurate merchant descriptors so that customers can recognize the transactions on their statements.

Provide good customer support.

Ensure rapid problem resolution.

Maintain a high level of customer satisfaction.

Minimize fraudulent transactions.

If excessive chargebacks or fraudulant changes occur, these actions might be taken:

You might be required to change your business processes to reduce the number chargebacks, fraud, or both.

Your acquiring institution might increase your discount rate.

Your acquiring institution might revoke your merchant account.

Contact your sales representative for information about products that can help prevent fraud.

Customer Financial Institutions (Issuers)

A customer financial institution, also known as an issuer
, provides payment cards to and underwrites lines of credit for their customers. The issuer provides monthly statements and collects payments. The issuer must follow the rules of the payment card companies to which they belong.

Payment Networks

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

Some payment networks, such as Visa and Mastercard, are trade associations that do not issue cards. Issuers are members of these associations, and they issue cards under license from the association.

Other networks, such as Discover

and American Express

, issue their own cards. Before you process cards from these companies, you must sign agreements with them.

Payment Processors

Payment processors connect with acquirers. Before you can accept payments, you must register with

a payment processor

.

An acquirer might require you to use a payment processor with an existing relationship with the acquirer.

Your payment processor

assigns one or more merchant IDs (MIDs) to your business. These unique codes identify your business during payment transactions.

This table lists the processors and corresponding card types that are supported for payment services.

Only the card types explicitly listed here are supported.

Payment Processor and Supported Card Types
Payment Processor	Supported Card Types	Notes
`Visa Platform Connect`	Different card types are supported for each `Visa Platform Connect` acquirer. See Visa Platform Connect Acquirers.	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.

`Visa Platform Connect` Acquirers

The following acquirers and card types are supported for Visa Platform Connect:

Supported `Visa Platform Connect` Acquirers and Card Types
Raw Processor Name	Processor Name	Supported Card Types
vdcabsa	Absa Bank on `Visa Platform Connect`	Visa, Mastercard, JCB, Diners Club
vdcagbkchina	Agricultural Bank of China (ABC) on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club `Visa Platform Connect` cannot process domestic transactions in China. `Visa Platform Connect` can process only cross-border transactions. A crossborder transaction is a transaction for which the payment card is issued in another country and accepted by a merchant in China.
networkintluae	Ahli United Bank in Bahrain, BLOM Bank, Network International	Visa, Mastercard, JCB, Diners Club
vdcaaib	Arab African International Bank (AAIB) on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcacbvietnam	Asia Commercial Bank (ACB) on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcasb	Auckland Savings Bank (ASB) on `Visa Platform Connect`	Visa, Mastercard
vdcanzbank	Australia and New Zealand Banking Group Ltd. (ANZ) on `Visa Platform Connect`	Visa, Mastercard
vdcaxis	Axis Bank Ltd. of India on `Visa Platform Connect`	Visa, Mastercard, Diners Club
vdcbanamex	Banco Nacional de México (Banamex) on `Visa Platform Connect`	Visa, Mastercard, American Express, Discover, JCB, Diners Club
vdcbcosafrabr	Banco Safra on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbbl	Bangkok Bank Ltd. on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcbankmuscat	Bank Muscat of Oman on `Visa Platform Connect`	Visa, Mastercard, American Express, Diners Club
vdcbay	Bank of Ayudhya (BAY) on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcbocmacau	Bank of China in Macau on `Visa Platform Connect`	Visa, Mastercard
vdcbocom	Bank of Communications on `Visa Platform Connect`	Visa, Mastercard
vdcbksinarmasid	Bank Sinarmas (Omise Ltd.) on `Visa Platform Connect`	Visa, Mastercard
vdcbcellao	Banque Pour Le Commerce Exterieur Lao (BCEL) on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB
vdcbarclaysbw	Barclays Bank Botswana on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbarclaysmu	Barclays Bank Mauritius Ltd. on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbarclaysghtzug	Barclays Bank of Ghana Ltd., Barclays Bank of Tanzania Ltd., and Barclays Bank of Uganda Ltd. on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbarclayske	Barclays Bank of Kenya on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbarclayszm	Barclays Bank of Zambia on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbarclayssc	Barclays Bank Seychelles on `Visa Platform Connect`	Visa, Mastercard, American Express
vdcbccardkr	BC Card Co., Ltd. on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB
vdccubtw	Cathay United Bank (CUB) on `Visa Platform Connect`	Visa, Mastercard, JCB
vdccitihkmo	Citibank Hongkong and Macau on `Visa Platform Connect`	Visa, Mastercard, Diners Club, JCB
vdccitimy	Citibank Malaysia on `Visa Platform Connect`	Visa, Mastercard
vdccitisg	Citibank Singapore Ltd. on `Visa Platform Connect`	Visa, Mastercard, JCB
vdccbq	Commercial Bank of Qatar on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdccredimax	CrediMax (Bahrain) on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdcctbc	CTBC Bank Ltd. on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcfdmsbn	First Data Merchant Solutions in Brunei on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcfdmshk	First Data Merchant Solutions in Hong Kong on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcfdmsmy	First Data Merchant Solutions in Malaysia on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcfdmssg	First Data Merchant Solutions in Singapore on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcfnb	FirstRand Bank on `Visa Platform Connect`	Visa, Mastercard, American Express, Diners Club
vdchsbcbank	Global Payments Asia Pacific on `Visa Platform Connect`	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 Global Payments Asia Pacific covers.
vdchabibltd	Habib Bank Ltd. (HBL) on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdchdfc	HDFC Bank Ltd. of India on `Visa Platform Connect`	Visa, Mastercard, Diners Club
vdcimbank	I&M Bank on `Visa Platform Connect`	Visa, Mastercard
vdcicici	ICICI of India on `Visa Platform Connect`	Visa, Mastercard
vdckeb	Korea Exchange Bank (KEB) on `Visa Platform Connect`	Visa, Mastercard, JCB `Visa Platform Connect` cannot process domestic transactions in Korea. `Visa Platform Connect` can process only cross-border transactions. A crossborder transaction is a transaction for which the payment card is issued in another country and accepted by a merchant in Korea.
vdcmashreqbk	Mashreq on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdcmaybankmy	Maybank on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB
vdcnbad	National Bank of Abu Dhabi (NBAD) on `Visa Platform Connect`	Visa, Mastercard, JCB, Diners Club
vdcnbk	National Bank of Kuwait (NBK) on `Visa Platform Connect`	Visa, Mastercard, Diners Club
vdcnacombk	National Commercial Bank on `Visa Platform Connect`	Visa, Mastercard, mada
vdcnijo	Network International (NI) Jordan on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdcocbc	Overseas Chinese Banking Corp (OCBC) on `Visa Platform Connect`	Visa, Mastercard
vdcpromerica	Promerica in Honduras and Nicaragua on `Visa Platform Connect`	Visa, Mastercard
vdcbni	PT Bank Negara Indonesia on `Visa Platform Connect`	Visa, Mastercard
vdcqnbqa	Qatar National Bank (QNB Group) on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdcsacomb	Sacombank on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcsmcc	Sumitomo Mitsui Card Co. on `Visa Platform Connect`	Visa
vdctaishintw	Taishin Bank Ltd. on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB
vdcuob	United Overseas Bank (UOB) in Singapore and Vietnam on `Visa Platform Connect`	Visa, Mastercard, JCB
vdcuobth	United Overseas Bank (UOB) in Thailand on `Visa Platform Connect`	Visa, Mastercard
vdcvantiv	Vantiv on `Visa Platform Connect`	Visa, Mastercard, American Express, Discover, JCB, Diners Club
vdcvietcombk	Vietcombank on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdcvietin	VietinBank on `Visa Platform Connect`	Visa, Mastercard, JCB, Diners Club
vdctechcomvn	Vietnam Technological and Commercial Joint Stock Bank (Techcombank) on `Visa Platform Connect`	Visa, Mastercard, American Express, JCB, Diners Club
vdcguatemala	Visa Guatemala on `Visa Platform Connect`	Visa
vdcvisanetuy	VisaNet Uruguay on `Visa Platform Connect`	Visa
vdcwestpac	Westpac on `Visa Platform Connect`	Visa, Mastercard
vdcwhb	Wing Hang Bank on `Visa Platform Connect`	Visa, Mastercard
vdcwinglung	Wing Lung Bank on `Visa Platform Connect`	Visa, Mastercard

Card Types

You can process payments with these kinds of cards:

Co-badged cards

Co-branded cards

Credit cards

Debit cards

Prepaid cards

Private label cards

Quasi-cash

You can process payments with these card types:

American Express

China UnionPay

Diners Club

Discover

JCB

Mastercard

Meeza (Pilot in Egypt only)

PayPak

Visa

Co-Badged Cards

Co-badged cards are credit and debit cards that integrate two or more payment networks.

mada Co-Badged Cards

mada is Saudi Arabia's domestic payment network.

These mada co-badged debit cards are supported:

Visa and mada

Mastercard and mada

mada co-badged debit cards are processed as follows:

Only domestic processing is supported in Saudi Arabia.

Transactions are sent directly to the Saudi Arabia Monetary Authority (SAMA) for processing.

Payer authentication is supported. Visa Secure is supported for co-badged Visa and mada cards. Mastercard Identity Check is supported for co-badged Mastercard and mada cards.

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.

Co-Branded Cards

Co-branded cards are credit cards that are branded with a merchant's logo, brand, or other identifier as well as the payment network logo. These cards are not limited for use at the branded merchant and can be used at any merchant that accepts credit cards.

Credit Cards

Cardholders use credit cards to borrow money from issuing banks to pay for goods and services offered by merchants that accept credit cards.

Debit Cards

A debit card is linked to a cardholder's checking account. A merchant who accepts the debit card can deduct funds directly from the account.

Prepaid Cards

Prepaid cards enable cardholders to pay for goods and services using money stored directly on the card.

Private Label Cards

Private label cards are issued by private companies. They enable cardholders to borrow money to pay for goods exclusively at the issuing company’s stores.

Quasi-Cash

Quasi-cash transactions involve instruments that are directly convertible to cash such as web wallets, travelers checks, cryptocurrency, and lottery tickets.

Transaction Types

This topic provides information about transaction types that are supported by your processor, such as card-present, card-not-present, and international transactions.

Card-Not-Present Transactions

When a customer provides a card number, but the card and the customer are not physically present at the merchant's location, the purchase is known as a card-not-present transaction
. Typical card-not-present transactions are internet and phone transactions. Card-not-present transactions pose an additional level of risk to your business because the customer’s identification cannot be verified. You can reduce that risk by using features such as the Address Verification System (AVS) and Card Verification Numbers (CVNs). The AVS and CVNs provide additional protection from fraud by verifying the validity of the customer’s information and notifying you when discrepancies occur.

Card-Present Transactions

When a customer uses a card that is physically present in a retail environment, the purchase is known as a card-present transaction
.

Authorizations with Card Verification Numbers

Card verification numbers (CVNs) are a required feature for the authorization service.

The CVN is printed on a payment card, and only the cardholder can access it. The CVN is used in card-not-present transactions as a verification feature. Using the CVN helps reduce the risk of fraud.

CVNs are not included in payment card track data and cannot be obtained from a card swipe, tap, or dip.

CVNs must not be stored after authorization.

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

CVN Locations and Terminology

For most cards, the CVN is a three-digit number printed on the back of the card, to the right of the signature field.

For American Express, the CVN is a four-digit number printed on the front of the card above the card number.

Image depicting the location of the CVN on the back of most cards and the front
of an American Express card. — CVN Locations

Each payment card company has its own name for the CVN value:

American Express and Discover call it the Card Identification Number
(CID).

JCB calls it the Card Authentication Value
(CAV2).

Mastercard calls it the Card Validation Code
(CVC2).

Visa calls it the Card Verification Value
(CVV2).

International Transactions

Consider compliance and merchant remittance funding when processing 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. This list describes areas of compliance that are especially important:

Merchant descriptor requirements—A merchant descriptor communicates merchant information to customers to remind them of the circumstances that triggered a payment. Merchant descriptors reduce the possibility of a chargeback. Accordingly, the merchant descriptor displayed on a customer’s statement should be a close match to the name on your website. It is not good practice to consolidate multiple websites into a single merchant account and use a generic descriptor that more-or-less covers all offerings.

Excessive chargebacks—To prevent an excessive number of chargebacks, you must maintain good customer support, rapid problem resolution, a high level of customer satisfaction, and transaction management processes that minimize fraudulent transactions. When payment card chargebacks become excessive, you must change business processes to reduce chargebacks. If chargebacks are not reduced to a satisfactory level, your account can be terminated.

Merchant Remittance Funding

You can request that the transaction proceeds be converted to another currency. Currency conversion uses a foreign exchange rate to calculate the conversion to the requested currency. The foreign exchange rate might be explicitly stated as a rate or implicitly stated as a transaction amount. The funded amount and can vary from day to day. The foreign exchange rate might also include an increase for the foreign exchange risk, sales commissions, and handling costs.

`Token Management Service`

The Token Management Service (TMS) tokenizes, securely stores, and manages customer and payment data. TMS enables you to:

Securely store a customer's payment details and their billing and shipping addresses.

Create a network token of a customer's payment card.

TMS simplifies your PCI DSS compliance. TMS passes back to you tokens that represent this data. You then store these tokens in your environment and databases instead of customer payment details.

TMS Token Types

Customer — Stores the buyer’s email address and the merchant's account ID for that buyer plus any other custom fields.

Shipping Address — Stores a shipping address for a specific customer.

Instrument Identifier — Stores either a payment card number or a bank account number and routing number

This resource creates either:

An Instrument Identifier token using details of a payment card or an ACH bank account.

A payment network token using the details of a payment card; also uses the card expiration date and billing address, which are pass-through only fields.

Payment Instrument — Stores a Payment Instrument using an Instrument Identifier token. It does not store the card number and cannot exist without an associated Instrument Identifier. It stores:

Card expiration date

Billing address

You can also choose to store this information yourself instead and store only the card number or bank account and routing number in an Instrument Identifier object.

Customer Payment Instrument — Creates and stores a payment instrument for a specific customer ID and an Instrument Identifier token.

TMS Features

Create, retrieve, update, and delete tokens.

Set a default payment instrument and shipping address for a customer.

Process follow-on payment transactions with token IDs.

Create and update tokens through bundled payment transactions.

Due to mandates from the Reserve Bank of India, Indian merchants cannot store personal account numbers (PAN). Use network tokens instead. For more information on network tokens, see the Network Tokenization section of the Token Management Service Guide.

Payment Services

Various services are involved in processing

payments.

These services enable customers to purchase goods and services. They also enable merchants to receive payments from customer accounts, to provide refunds, and to void transactions.

Authorizations

An authorization confirms that

a payment

card account holds enough funds to pay for a purchase. Authorizations can be made online or offline.

Online Authorizations

Online authorizations provide immediate confirmation of funds availability. The customer's financial institution also reduces the amount of credit available in the customer's account, setting aside the authorized funds for the merchant to capture at a later time. Authorizations for most payment cards are processed online. Typically, it is safe to start fulfilling the order when you receive an authorization confirmation.

An

online authorization confirmation and the subsequent hold on funds expire after a specific length of time. Therefore it is important to capture funds in a timely manner. The issuing bank sets the expiration time interval, but most authorizations expire within

5 to

7 days.

The issuing bank does not inform Cybersource when an authorization confirmation expires. By default, the authorization information for each transaction remains in the Cybersource database for 180 days after the authorization date. To capture an authorization that expired with the issuing bank, you can resubmit the authorization request.

Offline Authorizations

Online transactions require an internet connection. In situations where the internet is not available, for example, due to an outage, merchants can continue to take credit card payments using offline transactions. An offline authorization is an authorization request for which you do not receive an immediate confirmation about the availability of funds.

Offline authorizations have a higher level of risk than online transactions because they do not confirm funds availability or set aside the funds for later capture. Further, it can take up to 5 days to receive payment confirmations for offline transactions. To mitigate this risk, merchants may choose to fulfill orders only after receiving payment confirmation.

Pre-Authorizations

A pre-authorization enables you to authorize a payment when the final amount is unknown. It is typically used for lodging, auto rental, e-commerce, and restaurant transactions.

For a pre-authorization:

The authorization amount must be greater than zero.

The 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 pre-authorization that is not captured and not reversed.

In Europe, Russia, Middle East, and Africa, Mastercard charges fees for all pre-authorizations.

Chargeback protection is in effect for 30 days after the authorization.

Payment Network Token Authorizations

You can integrate authorizations with payment network tokens into your existing order management system. For an incremental authorization, you do not need to include any payment network tokenization fields in the authorization request because Cybersource obtains the payment network tokenization information from the original authorization request.

Authorization Workflow

This image and description show the authorization workflow:

The customer purchases goods or services from the merchant using a payment card.

You send an authorization request over secure internet connection to Cybersource. 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.

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

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.

The issuing bank approves or declines the request.

If funds are available, the issuing bank reserves the amount of the authorization request and returns an authorization approval to Cybersource.

If the issuing bank denies the request, it returns an authorization denial to Cybersource.

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

Sale

A sale is a bundled authorization and capture. Some processors and acquirers require a sale transaction instead of using separate authorization and capture requests. For other processors and acquirers, you can request a sale instead of a separate authorization and capture when you provide the goods or services immediately after taking an order.

There are two types of sale processing: dual-message processing and single-message processing.

Dual-Message Processing

Dual-message processing is a two-step process. The authorization is processed first. If the authorization is successful, the capture is processed immediately afterward. The response includes the authorization and the capture information. If the authorization is declined, the capture is not processed, and the response message includes only the authorization information.

Partial Authorizations

All debit and prepaid card processors as well as a limited number of credit card processors support partial authorizations when dual-message processing is in place.

When partial authorization is enabled, the issuing financial institution can approve a partial amount when the balance on the card is less than the requested amount. When a partial amount is authorized, the capture is not processed. The merchant can then use a second card to cover the balance, adjust the total cost, or void the transaction.

Single-Message Processing

Single-message processing treats the authorization and capture as a single transaction. There are important differences between dual-message processing and single-message processing:

Single-message processing treats the request as a full-financial transaction, and with a successful transaction, funds are immediately transferred from the customer account to the merchant account.

Authorization and capture amounts must be the same.

Some features cannot be used with single-message processing.

Authorization Reversals

The authorization reversal service releases the hold that an authorization placed on a customer’s payment card funds.

Each card-issuing financial institution has its own rules for deciding whether an authorization reversal succeeds or fails. When a reversal fails, contact the card-issuing financial institution to learn whether there is a different way to reverse the authorization.

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

An authorization reversal is a follow-on transaction that uses the request ID returned from an authorization. The main purpose of a follow-on transaction is to link two transactions. The request ID links the follow-on transaction to the original transaction. The authorization request ID is used to look up the customer’s billing and account information in the Cybersource database. You are not required to include those fields in the full authorization reversal request. The original transaction and follow-on transaction are linked in the database and in

the

Business Center.

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.

You cannot perform an authorization reversal if a transaction is in a review state, which can occur if you use a fraud management service. You must reject the transaction prior to authorization reversal. For more information, see the fraud management documentation in

the

Business Center.

Automatic Partial Authorization Reversals

Automatic partial authorization reversals are supported for:

Credit cards

Debit cards and prepaid cards.

Quasi-cash.

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.

Captures

A capture is a follow-on transaction to an authorization. It is used to transfer the authorized funds from the customer's account to the merchant account. To link the authorization transaction to the capture transaction, you include a request ID in your capture request. This request ID is returned to you in the authorization response.

Captures are typically not performed in real time. They are placed in a batch file and sent to the processor, and the processor settles all of the captures at one time. In most cases, these batch files are sent and processed outside of the merchant's business hours. It usually takes 2 to 4 days for the acquiring financial institution to deposit the funds into the merchant account.

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

It is not possible to perform a capture if a transaction is in a review state, which can occur if you use a fraud management service. You must accept the transaction prior to capture. For more information, see the fraud management documentation in

the

Business Center.

Capture Workflow

The capture workflow begins when you send a request for a capture.

The merchant sends a request for a capture to Cybersource.

For online captures, Cybersource validates the order information then sends an online capture to the payment processor.

For offline captures, Cybersource stores the capture request in a batch file and sends the batch file to the payment processor after midnight.

The processor validates the request and forwards it to the issuing bank.

The issuing bank transfers funds to the acquiring bank.

The payment processor does not notify Cybersource that the money has been transferred. To ensure that all captures are processed correctly, you should reconcile your capture requests with the capture reports from your processor.

Credits

Credits are payment refunds from a merchant to the cardholder after a cardholder pays for a product or service and that payment is captured by the merchant. When a credit request is successful, the issuer transfers funds from the merchant bank (acquirer) account to the customer's account. It typically takes 2 to 4 days for the acquirer to transfer funds from your merchant account.

You should carefully control access to the credit service. Do not request this service directly from your customer interface. Instead, incorporate this service as part of your customer service process. This process reduces the potential for fraudulent transactions.

There are two basic types of credits:

follow-on credits

and stand-alone credits.

Follow-On Credits

Follow-on credits, also known as refunds

, use the capture request ID to link the refund to a specific transaction.

This request ID is returned during the capture request (also known as a settlement
) and is used in all subsequent refunds associated with the original capture.

The request ID links the transaction to the customer’s billing and account information, so you are not required to include those fields in the credit request.

However, when you combine a request for a refund with a request for another service, such as the tax calculation service, you must provide the customer’s billing and account information.

Unless otherwise specified, refunds must be requested within 180 days of a settlement. You can request multiple refunds against a single capture or sale transaction as long as the total amount does not exceed the original purchase amount. To perform multiple refunds, use the same request ID in each request.

Stand-Alone Credits

Stand-alone credits are not connected to an original transaction. Stand-alone credits do not have a time restriction, and they can be used to issue refunds more than 180 days after a transaction settlement.

Credit Workflow

The credit workflow begins when you send a request for a credit.

A credit does not happen in real time. All of the credit requests for a day are typically placed in a file and sent to the processor as a single batch
transaction. In most cases, the batch transaction is settled overnight.

The merchant sends a request for a credit to Cybersource.

For online credits, Cybersource validates the order information then sends an online credit to the payment processor.

For offline credits, Cybersource stores the credit request in a batch file and sends the batch file to the payment processor after midnight.

The processor validates the request and forwards it to the acquiring bank.

The acquiring bank transfers funds to the issuing bank.

Voids

A void cancels a capture or credit request that was submitted but not yet processed by the processor.

Capture and credit requests are usually submitted once a day. A void request is declined when the capture or credit request has already been sent to the processor.

After a void is processed, you cannot credit or capture the funds. You must perform a new transaction to capture or credit the funds. Further, when you void a capture, a hold remains on the authorized funds. If you are not going to re-capture the authorization,

and if your processor supports authorization reversal after void (ARAV),

you should request an authorization reversal to release the hold on the unused funds.

A void uses the capture or credit request ID to link the transactions. The authorization request ID is used to look up the customer’s billing and account information, so there is no need to include those fields in the void request. You cannot perform a follow-on credit against a capture that has been voided.

Payment Features

You can apply features to different payment services to enhance the customer payment processing experience. This section includes an overview of these features:

Debit and Prepaid Card Payments

Airline Data

Interchange Optimization

Japanese Payment Options

Mastercard Bill Payments

Mastercard Expert Monitoring Solutions

Payer Authentication

Processing Payments Using Credentials

Relaxed Requirements for Address Data and Expiration Date in Payment Transactions

Split Shipments

Debit and Prepaid Card Payments

Debit cards are linked to a cardholder's checking account. A merchant who accepts the debit card can deduct funds directly from the linked cardholder's account.

You can process debit cards using these services:

Credit card services

PIN debit services

Partial authorizations, which are a special feature available for debit cards

Balance inquiries, which are a special feature available for debit cards

Requirements

In Canada, to process domestic debit transactions on Visa Platform Connect with Mastercard, you must contact customer support to have your account configured for this feature.

When using the Simple Order API in XML format, partial authorizations or balance responses require the XML schema version 1.52 or later.

Related Information

See Standard Payment Processing for information that shows you how to use credit card services.

See Debit and Prepaid Card Processing for information that shows you how to process authorizations that use a debit or prepaid card.

Airline Data

Airline data processing goes beyond basic payment transactions by allowing you to process specific travel data. This requires you to submit additional information, such as:

Carrier

Departure Date

Destination Airport

Purchase Date

Originating Airport

Ticket Class

Trip Legs

Supported Card Types

American Express

Discover

Mastercard

Visa

Supported Acquirers

These Visa Platform Connect acquirers are supported for airline data processing:

Agricultural Bank of China (ABC)

Ahli United Bank in Bahrain

Arab African International Bank (AAIB)

Asia Commercial Bank (ACB)

Auckland Savings Bank (ASB)

Axis Bank Ltd. of India

Bangkok Bank Ltd.

Bank Muscat of Oman

Bank of Ayudhya (BAY)

Bank of China (BOC)

Bank of Communications

Bank Sinarmas (Omise Ltd.)

Banque Pour Le Commerce Exterieur Lao (BCEL)

Barclays Bank Mauritius Ltd.

Barclays Bank Botswana

Barclays Bank of Ghana Ltd., Barclays Bank of Tanzania Ltd., and Barclays Bank of Uganda Ltd.

Barclays Bank of Kenya

Barclays Bank of Zambia

Barclays Bank Seychelles

BC Card Co., Ltd.

BLOM Bank

Cathay United Bank (CUB)

Citibank Hongkong and Macau

Citibank Singapore Ltd.

Commercial Bank of Qatar

CrediMax (Bahrain)

CTBC Bank Ltd.

FirstRand Bank

Global Payments Asia Pacific

Habib Bank Ltd. (HBL)

HDFC Bank Ltd. of India

I&M Bank

ICICI of India

Korea Exchange Bank (KEB)

Mashreq

National Bank of Abu Dhabi (NBAD)

National Bank of Kuwait (NBK)

National Commercial Bank

Network International

Overseas Chinese Banking Corp (OCBC)

Promerica in Honduras and Nicaragua

Qatar National Bank (QNB Group)

Raiffeisenbank

Rosbank

Taishin Bank Ltd.

United Overseas Bank (UOB) in Singapore and Vietnam

United Overseas Bank (UOB) in Thailand

Vietcombank

VTB24

Wing Lung Bank

Requirement

When you are ready to go live with airline data processing, contact Cybersource Customer Support to have your account configured to process airline data. If your account is not enabled, and you try to send airline transactions, you will receive an error for invalid data.

Related Information

See Airline Data Processing for information that shows you how to process payments that include airline data.

`Cybersource` Airline Data Processing

Cybersource does not store airline data. Instead, it functions as a pass-through service for the data. Cybersource enforces only the minimal level of field validation.

When you request an airline service, Cybersource responds with certain fields and values to indicate whether the airline data was processed. The response fields for each service are:

Authorization:

ccAuthReply_enhancedDataEnabled

Capture:

ccCaptureReply_enhancedDataEnabled

Credit:

ccCreditReply_enhancedDataEnabled

The possible values for the response fields are:

Y

: the airline data was included in the request to the processor.

N

: the airline data was not included in the request to the processor.

Cybersource temporarily disables your account's airline data processing capability and contacts you if your airline data transactions produce batching errors when the information is sent to the processor. If this happens, your request is not rejected, but you receive one of the above listed fields with the

N

value in the response indicating that airline data in the request has been ignored and not sent to the processor.

Airline Data Reference Information

This section contains reference information that is useful when using Airline Data.

Airline Document Type Codes

To indicate the purpose of a purchase, set the

airlineData_documentType

field to a value listed in the Code column.

Airline Document Type Codes
Code	Description
01	Passenger ticket
02	Additional collection
03	Excess baggage
04	Miscellaneous charge order (MCO) or prepaid ticket authorization
05	Special service ticket
06	Supported refund
07	Unsupported refund
08	Lost ticket application
09	Tour order voucher
10	Ticket by mail
11	Undercharge adjustment
12	Group ticket
13	Exchange adjustment
14	SPD or air freight
15	In-flight adjustment
16	Agency passenger ticket
17	Agency tour order or voucher
18	Agency miscellaneous charge order (MCO)
19	Agency exchange order
20	Agency group ticket
21	Debit adjustment for duplicate refund or use
22	In-flight merchandise order
23	Catalogue merchandise order
24	In-flight phone charges
25	Frequent flyer fee or purchase
26	Kennel charge
27	Animal transportation charge
28	Firearms case
29	Upgrade charge
30	Credit for unused transportation
31	Credit for class of service adjustment
32	Credit for denied boarding
33	Credit for miscellaneous refund
34	Credit for lost ticket refund
35	Credit for exchange refund
36	Credit for overcharge adjustment
37	Credit for multiple Unused tickets
38	Exchange order
39	Self-service ticket
41	In-flight duty-free purchase
42	Senior citizen discount booklets
43	Club membership fee
44	Coupon book
45	In-flight charges
46	Tour deposit
47	Frequent flyer overnight delivery charge
48	Frequent flyer fulfillment
49	Small package delivery
50	Vendor sale
51	Miscellaneous taxes or fees
52	Travel agency fee
60	Vendor refund or credit
64	Duty free sale
65	Preferred seat upgrade
66	Cabin upgrade
67	Lounge or club access or day pass
68	Agent assisted reservation or ticketing fee
69	Ticket change or cancel fee
70	Trip insurance
71	Unaccompanied minor
72	Standby fee
73	Curbside baggage
74	In-flight medical equipment
75	Ticket or pass print fee
76	Checked sporting or special equipment
77	Dry ice fee
78	Mail or postage fee
79	Club membership fee or temporary trial
80	Frequent flyer activation or reinstatement
81	Gift certificate
82	Onboard or in-flight prepaid voucher
83	Optional services fee
84	Advance purchase for excess baggage
85	Advance purchase for preferred seat upgrade
86	Advance purchase for cabin upgrade
87	Advance purchase for optional services
88	Wi-Fi
89	Packages
90	In-flight entertainment or internet access
91	Overweight bag fee
92	Sleep sets
93	Special purchase fee

Ancillary Service Category Codes

To indicate the service provided in an ancillary purchase, set the

ancillaryData_service_#_categoryCode

and

ancillaryData_service_#_subcategoryCode

fields to a value listed in the Ancillary Service Category Code column.

Ancillary Service Category Codes
Ancillary Service Category Codes	Description
BF	Bundled service
BG	Baggage fee
CF	Change fee
CG	Cargo
CO	Carbon offset
FF	Frequent flyer
GF	Gift card
GT	Ground transport
IE	In-flight entertainment
LG	Lounge
MD	Medical
ML	Meal or beverage
OT	Other
PA	Passenger assist fee
PT	Pets
SA	Seat fees
SB	Standby
SF	Service fee
ST	Store
TS	Travel service
UN	Unaccompanied travel
UP	Upgrades
WI	Wi-Fi

Interchange Optimization

Interchange fees are per-transaction transfer fees charged by your acquirer. The fee amount is based in part on the transaction amount that the acquirer submits to the payment network for clearing and settlement. Interchange optimization can help to reduce these fees for card-present transactions.

Payment Cards Supported with Interchange Optimization

Mastercard

Visa

Automatic Authorizations

Interchange optimization works by automatically performing additional authorization transactions for two types of card-not-present scenarios.

Automatic Authorization Refresh: If a capture request occurs more than 6 days after the date of the original authorization, the processor automatically obtains a fresh authorization for the capture amount.
Automatic Partial Authorization Reversal: If the capture does not need a fresh authorization but the capture amount is less than the authorization amount, the processor automatically performs a partial authorization reversal. The reversal releases the hold on unused credit card funds and ensures that the settlement amount matches the authorization amount.

How Interchange Optimization Transactions are Tracked

To find out when the processor performed automatic authorizations, see the daily processor report.

Limitations

Interchange optimization does not apply to transactions in which the payment card is present at the merchant's physical place of business.

Interchange optimization is not supported with incremental authorizations.

Requirement

Contact customer support to enable interchange optimization for your account.

Related Information

Merchant Financial Institutions (Acquirers)

Japanese Payment Options

Japanese payment options (JPO) extend the Cybersource payment card processing features to support payment methods used only in Japan. Japanese issuers, cardholders, merchants, and acquirers recognize payment methods that clarify the nature of a payment. JPO provides for more fine-grained identification of one-time payments and installment payments. You can offer your customers JPO payment methods that they select at the time of purchase.

JPO supports these payment methods:

Single payment

Bonus payment

Installment payment

Revolving payment

Combination of bonus payment and installment payment

Requests with Japanese payment options are accepted independently of your agreements with acquirers. When you submit a request with one of these 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.

For more information about the Japanese payment options, contact Customer Support of Cybersource KK (Japan).

Payment Cards Supported with JPO

JPO is supported for the Sumitomo Mitsui Card Co. acquirer with transactions that use Visa payment cards issued in Japan.

Services Supported with JPO

Authorization service.

Requirements

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Related Information

See Japanese Payment Options Processing for information that shows you how to process payments using JPO.

Micropayments

Services:

Authorization

Capture

Credit

Micropayments
are payments for less than one unit in the transaction’s currency.

Mastercard Bill Payments

In Brazil, you can participate in a Mastercard Bill Payment program. If your account is enrolled in the program, your customers can use their Mastercard payment cards to make payments on their outstanding bills.

A Mastercard card payment at the point of sale (POS) when goods or services are purchased is not part of the Mastercard Bill Payment program.

When you send an authorization request for a Mastercard Bill Payment, include the API field that specifies the bill payment type.

Limitation

The Mastercard Bill Payment program supports only bills paid in Brazil using Mastercard payments cards with Visa Platform Connect.

Requirements

Sign up with Mastercard to participate in their bill payment program.

Related Information

See Mastercard Bill Payment Processing for information that shows you how to process Mastercard Bill Payments.

Mastercard Expert Monitoring Solutions

Mastercard Expert Monitoring Solutions provides a predictive, behavior-based fraud score in real time during authorizations for card-not-present transactions. The score indicates the likelihood that the requested transaction is fraudulent and the type of fraud that is suspected.

To assign the fraud score for a transaction, Mastercard compares the customer’s transaction data to their transaction behavior history and to a regional card-not-present fraud detection model. The resulting score is returned in the body of the response message.

Limitations

This feature is supported on Mastercard Payment cards issued in the US only.

This feature is supported with Visa Platform Connect only.

Requirement

Contact customer support to enable Mastercard Expert Monitoring Solutions for your account.

After this feature is enabled for your account, Mastercard returns a fraud score for all your card-not-present authorization requests for Mastercard payment cards issued in the US.

Related Information

See Mastercard Expert Monitoring Solutions Processing for information that shows you how to obtain the transaction fraud score determined by Mastercard Expert Monitoring Solutions.

Payer Authentication

Payer authentication is run before a transaction is submitted for authorization. Most of the time payer authentication is bundled with authorization so that after payer authentication happens, the transaction is automatically submitted for authorization. Payer authentication and authorization can be configured to occur as separate operations. This section shows you how to run payer authentication as a separate process and pass the payer authentication data when seeking authorization for a transaction.

Payer authentication consists of a two-step verification process that adds an extra layer of fraud protection during the payment process. During transactions, the transaction device, location, past purchasing habits, and other factors are analyzed for indications of fraud. This process collects customer data during the transaction from at least two of these three categories:

Something you have
: A payment card or a payment card number

Something you know
: A password or pin

Something you are
: Facial recognition or fingerprint

Each of these payment card companies has its own payer authentication product:

American Express
: SafeKey

Discover
: ProtectBuy

JCB
: J/Secure

Mastercard
: Identity Check

Visa
: Visa Secure

Payer authentication can be used to satisfy the Strong Customer Authentication (SCA) requirement of the Payment Services Directive (PSD2). SCA applies to the European Economic Area (EEA) and the United Kingdom. SCA requires banks to perform additional checks when customers make payments to confirm their identity.

Related Information

See the Payer Authentication Developer Guide for more information about payer authentication.

See Payer Authentication Processing for information about how to process payments with payer authentication.

Relaxed Requirements for Address Data and Expiration Date in Payment Transactions

With relaxed requirements for address data and the expiration date, not all standard payment request fields are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required.

Related Information

See Relaxed Requirements for Address Data and Expiration Date in Payment Transactions for information about how to process payments with relaxed requirements for address data and expiration date.

Split Shipments

Split shipments enable you to split an order into multiple shipments with multiple captures. You can use this feature when a customer orders a product that is not yet available, or when one or some products are available but not all. You are able to request multiple partial captures for one authorization, multiple authorizations and one capture, or an authorization and a sale.

Cybersource provides the split shipment services for authorizations and captures. There are three scenarios and actions you can take:

Multiple authorizations—Request more than one authorizations; when the order is placed for the unavailable product and after the product becomes available to ship.

Multiple partial captures—Request an authorization, and then request multiple partial captures for the amount of the products you ship. When the remaining product becomes available, ship it and request another capture.

Multiple authorizations with multiple partial captures—Request more than one authorizations and captures when all the products in the order are not available for immediate shipment. After the other products become available, request another authorization, and then a capture when you ship the remaining product.

How Split Shipments Transactions are Linked

All 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 partial captures, Cybersource requests the additional authorizations for you.

Obtaining the Status of a System-Generated Authorization

A system-generated authorization is not performed in real time. The response message that you receive indicates that the request was received, not whether it was approved or declined.

A system-generated authorization can be declined for the same reasons that a regular authorization can be declined. Cybersource recommends you use one of following methods to obtain the status of the system-generated authorization request before shipping the product:

Business Center—Use the capture request ID to search for the follow-on capture. The details for all related transactions are displayed on the Transaction Details
page. It can take a maximum of 6 hours for the status of the system-generated authorization request to be available.

Transaction Detail API—You must use version 1.3 or later of the report and include the parameter

includeExtendedDetail

in your query. It can take a maximum of 6 hours for the status of the system-generated authorization request to be available.

Transaction Exception Detail Report—Cybersource recommends you use this report on a daily basis to identify transactions that were declined.

Additional Authorizations

When you need an additional authorization for an order, you can use the

link-to-request

field to link follow-on authorizations to the original authorization in addition to the basic fields required for every authorization request. The follow-on 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, the authorization request must include the subsequent authorization fields that are required for merchant-initiated transactions.

Additional Captures

When you need an additional capture for an order, Cybersource performs a system-generated authorization for additional capture requests 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.

Related Information

See Authorizing a Sale for a Product Not Yet Available for guidelines on how to process a payment when a product is not available.

See Processing an Authorization and Two Captures for Multiple Products or Processing Two Authorizations and a Capture for Multiple Products for guidelines on how to process payments for multiple products.

Introduction to Credentialed Transactions

Credentialed transactions are transactions that involve either storing a customer's payment credentials for future transactions or using a customer's already stored payment credentials. When processing a credentialed transaction, you must indicate the type of credentialed transaction and the reason for the transaction. Credentialed transactions are also known as credential-on-file
(COF) transactions.

There are several types of credentialed transactions:

Customer-Initiated Transactions (CITs):
Any transaction a customer is actively participating in such as making a card-present payment, completing an online checkout, or by using a stored credential. CIT transactions can store the customer's credentials in your system for future CITs or merchant-initiated transactions.

Merchant-Initiated Transactions (MITs):
Any transaction a merchant initiates without the customer's participation such as an industry practice transaction or a standing instruction transaction.

Industry Practice Transactions:
MITs that are performed as subsequent transactions to a CIT because the initial transaction could not be completed in one transaction. Not every industry practice transaction involves a stored credential. If a stored credential is used only for one transaction, that transaction is not considered a credentialed transaction.

Standing Instruction Transactions:
MITs that are performed to follow agreed-upon instructions from the customer for the provision of goods and services.

Supported Services

These are the supported merchant-initiated services:

Delayed Authorization

Incremental Transactions

Installment Transactions

Mastercard Standing Order Transactions

Mastercard Subscription Transactions

No-Show Transactions

Reauthorization

Recurring Transactions

Resubmission

Unscheduled Credentials-on-File Transactions

The service determines the reason for the credentialed transaction.

Testing the Payment Services

To ensure that requests are processed correctly, you must test the basic success and error conditions for each service you plan to use.

Requirements for Testing

Before you can test, contact customer support to activate the credit card services and configure your account for testing. You must also contact your processor to set up your processor account.

When building your connection to the Cybersource payment gateway, ensure that you have implemented controls to prevent card testing or card enumeration attacks on your platform.

For more information, see the best practices guide.

When we detect suspicious transaction activity associated with your merchant ID, including a card testing or card enumeration attack, Cybersource reserves the right to enable fraud management tools on your behalf in order to mitigate the attack. The fraud team might also implement internal controls to mitigate attack activity. These controls block traffic that is perceived as fraudulent. Additionally, if you are using one of our fraud tools and experience a significant attack, our internal team might modify or add rules to your configuration to help prevent the attack and minimize the threat to our infrastructure. However, any actions taken by Cybersource would not replace the need for you to follow industry standard best practices to protect your systems, servers, and platforms.

Follow these requirements when you test your system:

Use your regular merchant ID.

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.

Simple Order API test server:

https://ics2wstesta.ic3.com/commerce/1.x/transactionProcessor

Test Card Numbers

Use these payment card numbers to test the authorization, capture, and credit services. Remove the spaces from the test card numbers when sending them to the test system. Do not use real payment card numbers. To test card types that are not included in the list, use an account number that is in the card’s BIN range. For best results, try each test with a different service request and with different test payment card numbers.

The test card numbers that are provided are formatted with Xs for zeroes in the card number. When testing with the card numbers, replace each X with a 0 (zero).

American Express—3782 8224 631X XX5

Discover—6X11 1111 1111 1117

JCB—3566 1111 1111 1113

Maestro (International)

5X33 9619 89X9 17

5868 2416 0825 5333 38

Maestro (UK Domestic)—the issue number is not required for Maestro (UK Domestic) transactions.

6759 4111 XXXX XXX8

6759 56XX 45XX 5727 054

5641 8211 1116 6669

Mastercard

2222 42XX XXXX 1113

2222 63XX XXXX 1125

5555 5555 5555 4444

UATP—1354 1234 5678 911

Visa—4111 1111 1111 1111

Using Amounts to Simulate Errors

You can simulate 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 more information, see: Simple Order API Testing Information.

Test American Express Card Verification

Before using CVN with American Express, it is strongly recommended that you follow these steps:

Contact customer support to have your account configured for CVN. Until you do this, you will receive a

1

in the

ccAuthReply_cvCode

response field.

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.

Standard Payment Processing

This section shows you how to process various authorization, capture, credit, and sales transactions.

Basic Authorizations

This section provides the information you need in order to process a basic authorization.

Supported Card Types

All supported card types can process basic authorizations. For a list of all supported card types, see Payment Processors.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Declined Authorizations

If an authorization is declined, you can use response categories to help you decide whether to retry or block a declined transaction. These response fields provide additional information:

ccAuthReply_paymentInsightsInformation_responseInsightsCategory

ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode

These fields are available starting in the XML schema version 1.193.

Category codes have possible values (such as

01

) each of which corresponds to a category that contains a description.

You cannot retry this category code and category:

01 ISSUER_WILL_NEVER_APPROVE

For these values, you can retry the transaction a maximum of 15 times over a period of 30 days:

02 ISSUER_CANNOT_APPROVE_AT_THIS_TIME

03 ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS

: Data quality issue. Revalidate data prior to retrying the transaction.

04 GENERIC_ERROR

97 PAYMENT_INSIGHTS_INTERNAL_ERROR

98 OTHERS

99 PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND

Required Fields for Processing a Basic Authorization

Use these required fields for processing a basic authorization.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API Field Reference for the Simple Order API

Country-Specific Required Fields for Processing a Basic Authorization

Use these country-specific required fields to process a basic authorization.

Argentina

billTo_merchantTaxID: Required for Mastercard transactions.

transactionLocalDateTime: Required in Argentina when the time zone is not included in your account. Otherwise, this field is optional.

Brazil

billTo_personalID: Required for combo card transactions.
ccAuthService_overridePaymentDetails: Required for combo card line-of-credit and prepaid-card transactions.

Chile

billTo_merchantTaxID: Required for Mastercard transactions.

Egypt

card_cardType: Required for Meeza transactions. Set the value to
067
.
invoiceHeader_merchantDescriptorCountry: Required for Meeza transactions. Set the value to
EG
.

Paraguay

billTo_merchantTaxID: Required for Mastercard transactions.

Saudi Arabia

transactionMode: Required only for merchants in Saudi Arabia.

Taiwan

Name: card_hashedAccountNumber: Required only for merchants in Taiwan.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing a Basic Authorization

Request

billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street1=201 S. Division St.
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
merchant_id=npr_paymentech
merchant_referenceCode=TC42703-1
purchaseTotals_currency=usd
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=usd
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Response to a Declined Request

requestID=6629977932421985593067
merchantReferenceCode=Merchant_REF
decision=REJECT
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=Y
ccAuthReply_paymentNetworkTransactionID=111222
ccAuthReply_transactionID=111222
ccAuthReply_paymentInsightsInformation_responseInsightsCategory=
    ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS
ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode=03
ccAuthReply_processorResponse=183  
ccAuthReply_reasonCode=233

Authorizations with Line Items

This section shows you how to process an authorization with line items.

The main difference between a basic authorization and an authorization that includes line items is that the

purchaseTotals_grandTotalAmount

field, which is included in a basic authorization, is substituted with one or more line items that are included in

the

item_#_

fields, starting with the

item_0_

fields

.

Fields Specific to this Use Case

These

fields

are required for each line item that you use:

item_#_unitPrice
item_#_quantity
item_#_productCode
item_#_productSKU: Optional when
item_#_productCode
is set to
default
,
shipping_only
,
handling_only
, or
shipping_and_handling
item_#_productName: Optional when
item_#_productCode
is set to
default
,
shipping_only
,
handling_only
, or
shipping_and_handling

At a minimum, you must include the

item_#_unitPrice

field in order to include a line item in an authorization. When this field is the only field included in the authorization, the system sets:

item_#_productCode

:

default

item_#_quantity

:

1

For example, these three line items are valid.

item_0_unitPrice=10.00
item_1_unitPrice=5.99
item_1_quantity=3
item_1_productCode=shipping_only
item_2_unitPrice=29.99
item_2_quantity=3
item_2_productCode=electronic_good
item_2_productSKU=12384569
item_2_productName=receiver

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Optional Line Item Fields

These fields can be used to provide more line item information. For more information on each field, see the field reference guide:

item_#_buyerRegistration

item_#_commodityCode

item_#_DiscountAmount

item_#_discountIndicator

item_#_discountManagementIndicator

item_#_discountRate

item_#_invoiceNumber

item_#_nationalTax

item_#_orderAcceptanceCity

item_#_orderAcceptanceCountry

item_#_orderAcceptancePostalCode

item_#_orderAcceptanceState

item_#_orderOriginCity

item_#_orderOriginCountry

item_#_orderOriginPostalCode

item_#_orderOriginState

item_#_otherTax_#_passengerFirstName

item_#_otherTax_#_passengerLastName

item_#_productCode

item_#_productDescription

item_#_productName

item_#_productSKU

item_#_quantity

item_#_shippingDestinationType

item_#_sign

item_#_taxAmount

item_#_taxRate

item_#_totalAmount

item_#_typeOfSupply

item_#_unitPrice

Required Fields for Processing an Authorization with Line Items

Use these required fields for processing an authorization that includes line items.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode: Required when
billTo_personalID
is included in the request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount: Either
purchaseTotals_grandTotalAmount
or
item_#_unitPrice
must be included in the request.

Related Information

API field reference guide for the Simple Order API

Country-Specific Required Fields for Processing an Authorization with Line Items

Use these country-specific required fields to process a process an authorization with line items.

Argentina

billTo_merchantTaxID: Required for Mastercard transactions.

transactionLocalDateTime: Required in Argentina when the time zone is not included in your account. Otherwise, this field is optional.

Brazil

billTo_personalID: Required for combo card transactions.
ccAuthService_overridePaymentDetails: Required for combo card line-of-credit and prepaid-card transactions.

Chile

billTo_merchantTaxID: Required for Mastercard transactions.

Paraguay

billTo_merchantTaxID: Required for Mastercard transactions.

Saudi Arabia

transactionMode: Required only for merchants in Saudi Arabia.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Authorization with Line Items

Request

billTo_city=Palo Alto
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=94053
billTo_state=CA
billTo_street1=123 Main St.
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
dcc_dccIndicator=1
merchant_id=MID23
merchant_referenceCode=Merchant_REF
purchaseTotals_currency=usd
item_0_unitPrice=10.00
item_1_unitPrice=5.99
item_1_quantity=3
item_1_productCode=shipping_only
item_2_unitPrice=29.99
item_2_quantity=3
item_2_productCode=electronic_good
item_2_productSKU=12384569
item_2_productName=receiver
purchaseTotals_exchangeRate=0.91
purchaseTotals_originalAmount=107.33
purchaseTotals_originalCurrency=eur

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=usd
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=117.94
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Authorizations with Payment Network Tokens

This section shows you how to successfully process an authorization with payment network tokens.

Due to mandates from the Reserve Bank of India, Indian merchants cannot store personal account numbers (PAN). Use network tokens instead. For more information on network tokens, see Network Tokenization in the Token Management Service Developer Guide
.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizations with Payment Network Tokens

Use these required fields for processing an authorization with payment network tokens.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_email
billTo_firstName
billTo_lastName
billTo_street1
ccAuthService_networkTokenCryptogram
paymentNetworkToken_transactionType
purchaseTotals_currency
purchaseTotals_grandTotalAmount
token_expirationMonth
token_expirationYear

Related Information

API field reference guide for the Simple Order API

Optional Fields for Authorizations with Payment Network Tokens

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode: Required only for transactions in the U.S. and Canada.
billTo_state: Required only for transactions in the U.S. and Canada.
billTo_street1
card_accountNumber: Set to the token value that you received from the token service provider.
card_cardType: It is strongly recommended 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_expirationMonth: Set to the token expiration month that you received from the token service provider.
card_expirationYear: Set to the token expiration year that you received from the token service provider.
ccAuthService_cavv: For 3-D Secure in-app transactions for Visa
and JCB
, set to the 3-D Secure cryptogram. Otherwise, set to the network token cryptogram.
ccAuthService_commerceIndicator
ccAuthService_networkTokenCryptogram
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount or item_#_unitPrice
paymentNetworkToken_transactionType
paymentNetworkToken_requestorID: Required on Visa Platform Connect
ucaf_authenticationData: For Mastercard requests, set this field to the Identity Check cryptogram.
ucaf_collectionIndicator: For Mastercard requests, set the value to
2
.

Related Information

API field reference guide for the Simple Order API

Simple Order API Example: Authorizations with Payment Network Tokens

Request

<requestMessage>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>16.00</grandTotalAmount>
    </purchaseTotals>
    <card>
        <accountNumber>4111111111111111</accountNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>2031</expirationYear>
    </card>
    <ccAuthService run="true">
        <networkTokenCryptogram>qE5juRwDzAUFBAkEHuWW9PiBkWv=</networkTokenCryptogram>
    </ccAuthService>
    <paymentNetworkToken>
        <transactionType>1</transactionType>
    </paymentNetworkToken>
</requestMessage>

Successful Response

<c:replyMessage>
    <c:merchantReferenceCode>Postman-1684858432</c:merchantReferenceCode>
    <c:requestID>6848584316126969103007</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>16.00</c:amount>
        <c:authorizationCode>888888</c:authorizationCode>
        <c:avsCode>X</c:avsCode>
        <c:avsCodeRaw>I1</c:avsCodeRaw>
        <c:authorizedDateTime>2023-05-23T16:13:51Z</c:authorizedDateTime>
        <c:processorResponse>100</c:processorResponse>
        <c:reconciliationID>78849228NHPFQCKD</c:reconciliationID>
        <c:paymentNetworkTransactionID>123456789619999</c:paymentNetworkTransactionID>
     </c:ccAuthReply>
     <c:card>
         <c:cardType>001</c:cardType>
     </c:card>
</c:replyMessage>

Authorizations with a Card Verification Number

This section shows you how to process an authorization with a Card Verification Number (CVN).

CVN Results

The response 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 value that corresponds to the raw response code. This value is returned in the

ccAuthReply_cvCode

field.

Even when the CVN does not match the expected value, the issuing bank might still authorize the transaction. You will receive a CVN decline, 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.

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, the capture request is not processed unless you set the

businessRules_ignoreCVResult

field to

true

.

CVN Results for American Express: A value of
1
in the
ccAuthReply_cvCode
field indicates that your account is not configured to use card verification. Contact customer support to have your account enabled for this feature.
CVN Results for Discover: 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.
CVN Results for Visa and Mastercard: A CVN code of
D
or
N
causes the request to be declined with a reason code value of
230
. You can still capture the transaction, but you must review the order to ensure that it is legitimate.

Cybersource, not the issuer, assigns the CVN decline to the authorization. You can capture any authorization that has a valid authorization code from the issuer, even when the request receives a CVN decline.

When the issuer 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.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Authorization with a Card Verification Number

Use these required fields for processing an authorization that includes a Card Verification Number (CVN).

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_cvNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Optional Fields for Processing an Authorization with a Card Verification Number

You can use these optional fields to include additional information when processing an authorization with a card verification number.

businessRules_ignoreCVResult
card_cvIndicator

Simple Order Example: Processing an Authorization with a Card Verification Number

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
billTo_email=jdoe@example.com
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
card_cvNumber=999
card_cardType=001

Response to a Successful Request

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_authorizationCode=123456
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=YYY
ccAuthReply_processorResponse=A
ccAuthReply_paymentNetworkTransactionID=3312345

Marketplace Authorizations with Foreign Retailers

Visa Platform Connect requires marketplaces to identify foreign retail transactions when the marketplace and issuer are in the European Economic Area (EEA), the U.K., and Gibraltar and the retailer is in a different country. For marketplace transactions, the marketplace is the merchant and the retailer is the sub-merchant. Marketplace foreign retail transactions are identified in the Business Center on the transactions details page.

This feature is intended for captures. You can include this information in an authorization, but this is not the preferred method. The capture request data overrides the authorization request data.

Fields Specific to this Use Case

These fields are required for this use case:

invoiceHeader_merchantDescriptorCountry: Set this value to the marketplace country.
invoiceHeader_submerchantCountry: Set this value to the retailer country.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing a Marketplace Authorization with a Foreign Retailer

Use these required fields for processing a basic authorization.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
invoiceHeader_merchantDescriptorCountry: Set this value to the marketplace country.
invoiceHeader_submerchantCountry: Set this value to the retailer country.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing a Authorization with a Foreign Retailer

Request

billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street1=201 S. Division St.
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
invoiceHeader_merchantDescriptorCountry=GB
invoiceHeader_submerchantCountry=AU
merchant_id=abc123
merchant_referenceCode=TC42703-1
purchaseTotals_currency=GBP
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=GBP
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2024-09-12T154953Z

Response to a Declined Request

requestID=6629977932421985593067
merchantReferenceCode=Merchant_REF
decision=REJECT
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=Y
ccAuthReply_paymentNetworkTransactionID=111222
ccAuthReply_transactionID=111222
ccAuthReply_paymentInsightsInformation_responseInsightsCategory=
    ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS
ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode=03
ccAuthReply_processorResponse=183  
ccAuthReply_reasonCode=233

Authorizations with Strong Customer Authentication Exemption

This section shows you how to process an authorization with a strong customer authentication (SCA) exemption.

You can use SCA exemptions to streamline the payment process. SCA exemptions are part of the European second Payment Services Directive (PSD2) and allow certain types of low-risk transactions to bypass additional authentication steps while still remaining compliant with PSD2. You can choose which exemption can be applied to a transaction, but the card-issuing bank actually grants an SCA exemption during card authentication.

You can process an authorization with two types of SCA exemptions:

Exemption on Authorization
: Send an authorization without payer authentication and request an SCA exemption on the authorization. If it is not approved, you may be required to request further authentication upon retry.

Exemption on Authentication
: Request an SCA exemption during payer authentication and if successful, send an authorization including the SCA exemption details.

Depending on your processor, use one of these exemption fields:

If you send more than one SCA exemption field with a single authentication, the transaction is denied.

Authentication Outage
: Payer authentication is not available for this transaction due to a system outage.

B2B Corporate Card
: Payment cards specifically for business-to-business transactions are exempt.

Delegated Authentication
: Payer authentication was performed outside of the authorization workflow.

Follow-On Installment Payment
: Installment payments of a fixed amount are exempt after the first transaction.

Follow-On Recurring Payment
: Recurring payments of a fixed amount are exempt after the first transaction.

Low Risk
: The average fraud levels associated with this transaction are considered low.

Low Value
: The transaction value does not warrant SCA.

Merchant Initiated Transactions
: As follow-on transactions, merchant-initiated transactions are exempt.

Stored Credential Transaction
: Credentials are authenticated before storing, so stored credential transactions are exempt.

Trusted Merchant
: Merchants registered as trusted beneficiaries.

Fields Specific to the Strong Customer Authentication Exemptions

Use one of these fields to request an SCA exemption:

ccAuthService_authenticationOutageExemptionIndicator: Exemption type: Authentication Outage; Value:
1
ccAuthService_secureCorporatePaymentIndicator: Exemption type: B2B Corporate Card Transaction; Value:
1
ccAuthService_ delegatedAuthenticationExemptionIndicator: Exemption type: Delegated Authentication; Value:
1
ccAuthService_riskAnalysisExemptionIndicator: Exemption type: Low Risk Transaction; Value:
1
ccAuthService_lowValueExemptionIndicator: Exemption type: Low Value Transaction; Value:
1
ccAuthService_trustedMerchantExemptionIndicator: Exemption type: Trusted Merchant Transaction; Value:
1

Country-Specific Requirements

These fields are specific to certain countries and regions.

Argentina

billTo_merchantTaxID: Required for Mastercard transactions.

transactionLocalDateTime: Required when the time zone is not included in your account. Otherwise, this field is optional.

Brazil

billTo_personalID: Required for combo card transactions.
ccAuthService_overridePaymentDetails: Required for combo card line-of-credit and prepaid-card transactions.

Chile

billTo_merchantTaxID: Required for Mastercard transactions.

Paraguay

billTo_merchantTaxID: Required for Mastercard transactions.

Saudi Arabia

transactionMode

Taiwan

card_hashedAccountNumber

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Authorization with an SCA Exemption

Use these required fields for processing an authorization that includes an SCA exemption.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Authorization with an SCA Exemption for Low Value Transactions

Request

<requestMessage>
  <merchantID>{{merchantID}}</merchantID>
  <merchantReferenceCode>Postman-{{$timestamp}}</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>
    <email>null@cybersource.com</email>
  </billTo>
  <purchaseTotals>
    <currency>USD</currency>
    <grandTotalAmount>1.01</grandTotalAmount>
  </purchaseTotals>
  <card>
    <accountNumber>4111111111111111</accountNumber>
    <expirationMonth>12</expirationMonth>
    <expirationYear>2023</expirationYear>
    <cardType>001</cardType>
  </card>
  <ccAuthService run="true"/>
</requestMessage>

Response to a Successful Request

<c:replyMessage>
  <c:merchantReferenceCode>Postman-1666374834</c:merchantReferenceCode>
  <c:requestID>6663748348516429203007</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>1.01</c:amount>
    <c:authorizationCode>888888</c:authorizationCode>
    <c:avsCode>X</c:avsCode>
    <c:avsCodeRaw>I1</c:avsCodeRaw>
    <c:authorizedDateTime>2022-10-21T17:53:54Z</c:authorizedDateTime>
    <c:processorResponse>100</c:processorResponse>
    <c:reconciliationID>66737280B9CGUCCP</c:reconciliationID>
    <c:paymentNetworkTransactionID>123456789619999</c:paymentNetworkTransactionID>
  </c:ccAuthReply>
  <c:card>
    <c:cardType>001</c:cardType>
  </c:card>
</c:replyMessage>

Zero Amount Authorization

This section provides the information that you need in order to process a zero amount authorization.

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.

Processor-Specific Information

Visa Platform Connect: AVS and CVN are supported.; Supported for Internet, MOTO, and card-present transactions. Do not try to perform a zero amount authorization for a recurring payment, installment payment, or payer authorization transaction.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing
a Zero Amount Authorization

Use these required fields for processing

a zero amount authorization

.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Country-Specific Required Fields for Processing a Zero Amount Authorization

Use these country-specific required fields to process a zero amount authorization.

Argentina

billTo_merchantTaxID: Required for Mastercard transactions.

transactionLocalDateTime: Required in Argentina when the time zone is not included in your account. Otherwise, this field is optional.

Brazil

billTo_personalID: Required for combo card transactions.
ccAuthService_overridePaymentDetails: Required for combo card line-of-credit and prepaid-card transactions.

Saudi Arabia

transactionMode

Taiwan

Name: card_hashedAccountNumber

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing a Zero Amount Authorization

Request

billTo_city=Sao Paulo
billTo_country=BR
billTo_email=null@cybersource.com
billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=01310-000
billTo_state=SP
billTo_street1=R. Augusta
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
merchant_id=MID23
merchant_referenceCode=Merchant_REF
purchaseTotals_currency=mxn
purchaseTotals_grandTotalAmount=0

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=0
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Pre-Authorizations

This section provides the information you need in order to process a pre-authorization.

A pre-authorization enables you to authorize a payment when the final amount is unknown. It is typically used for lodging, auto rental, e-commerce, and restaurant transactions.

For a pre-authorization:

The authorization amount must be greater than zero.

The 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 pre-authorization that is not captured and not reversed.

In Europe, Russia, Middle East, and Africa, Mastercard charges fees for all pre-authorizations.

Chargeback protection is in effect for 30 days after the authorization.

Supported Card Types

All supported card types can process basic authorizations. For a list of all supported card types, see Payment Processors.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for a Pre-Authorization

Use these required fields for processing a pre-authorization.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Country-Specific Required Fields for Processing a Pre-Authorization

Use these country-specific required fields to process a pre-authorization.

Argentina

billTo_merchantTaxID: Required for Mastercard transactions.

transactionLocalDateTime: Required in Argentina when the time zone is not included in your account. Otherwise, this field is optional.

Brazil

billTo_personalID: Required for combo card transactions.
ccAuthService_overridePaymentDetails: Required for combo card line-of-credit and prepaid-card transactions.

Chile

billTo_merchantTaxID: Required for Mastercard transactions.

Egypt

card_cardType: Required for Meeza transactions. Set the value to
067
.
invoiceHeader_merchantDescriptorCountry: Required for Meeza transactions. Set the value to
EG
.

Paraguay

billTo_merchantTaxID: Required for Mastercard transactions.

Saudi Arabia

transactionMode: Required only for merchants in Saudi Arabia.

Taiwan

Name: card_hashedAccountNumber: Required only for merchants in Taiwan.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing a Pre-Authorization

Request

billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street1=201 S. Division St.
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
merchant_id=npr_paymentech
merchant_referenceCode=TC42703-1
purchaseTotals_currency=usd
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=usd
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Response to a Declined Request

requestID=6629977932421985593067
merchantReferenceCode=Merchant_REF
decision=REJECT
ccAuthReply_avsCode=Y
ccAuthReply_avsCodeRaw=Y
ccAuthReply_paymentNetworkTransactionID=111222
ccAuthReply_transactionID=111222
ccAuthReply_paymentInsightsInformation_responseInsightsCategory=
    ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS
ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode=03
ccAuthReply_processorResponse=183  
ccAuthReply_reasonCode=233

Incremental Authorizations

This section shows you how to process an incremental authorization.

Incremental authorizations allow merchants to add additional products and services to an existing authorization. This section will show you how to append an original authorization to include additional transactions.

The supported card types for incremental authorizations are Mastercard and Visa.

The incremental authorization service has these limitations:

Maximum of 100 incremental authorizations per transaction, in addition to the initial authorization.

Interchange optimization is not supported.

Split shipments are not supported.

Supported Card Types

These card types support incremental authorizations:

Mastercard

Visa

Endpoint

Set the

ccIncrementalAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Incremental Authorization

Use these required fields for processing an incremental authorization.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

ccAuthService_run: Set the value to
true
.
ccIncrementalAuthService_authRequestID: Set this field to the request ID that was included in the original authorization response message.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthReason

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

Related Information

API field reference guide for the Simple Order API

Country-Specific Required Fields for Processing an Incremental Authorization

Use these country-specific required fields to process an incremental authorization.

Argentina

transactionLocalDateTime: Required in Argentina when the time zone is not included in your account. Otherwise, this field is optional.

Related Information

API field reference guide for the Simple Order API

Optional Field for Processing an Incremental Authorization

You can use this optional field to include your transaction ID when processing an incremental authorization.

merchantTransactionIdentifier

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Incremental Authorization

Request

ccIncrementalAuthService_run=true
merchantID=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=101.00

Response to a Successful Request

additionalData=ABC
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=901.00
ccIncrementalAuthReply_amount=101.00
ccIncrementalAuthReply_authorizationCode=831000
ccIncrementalAuthReply_paymentNetworkTransactionID=016153570198200 
ccIncrementalAuthReply_processorResponse=00
ccIncrementalAuthReply_authorizedDateTime=2022-03-21T174116Z
ccIncrementalAuthReply_reconciliationID=6474558510303169979915
merchantReferenceCode=33557799
receiptNumber=816709
requestID=6478844759930310739813

Final Authorization Indicator

The purpose of this feature is to ensure that unused funds are reversed, so that customer’s funds are available again when an order is not fulfilled.

For an authorization with an amount greater than zero, indicate whether the authorization is a final authorization, a pre-authorization, or an undefined authorization.

You can set a default authorization type in your account. To set the default authorization type in your account, contact customer support.

Chargeback protection is in effect for seven days after the authorization.

Supported
Services

Authorization

Incremental authorization

Supported Card Types

Co-badged Mastercard and mada. You must identify the card type as Mastercard. Supported only on Visa Platform Connect.

Maestro (International)

Maestro (UK Domestic)

Mastercard

Requirements for Final Authorizations

For a final authorization:

The authorization amount must be greater than zero.

The authorization amount must be the final amount that the customer agrees to pay.

The authorization should not be cancelled after it is approved except when a system failure occurs.

The authorization must be submitted for capture within seven calendar days of its request.

The capture amount and currency must be the same as the authorization amount and currency.

Pre-Authorizations

A pre-authorization enables you to authorize a payment when the final amount is unknown. It is typically used for lodging, auto rental, e-commerce, and restaurant transactions.

For a pre-authorization:

The authorization amount must be greater than zero.

The 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 pre-authorization that is not captured and not reversed.

In Europe, Russia, Middle East, and Africa, Mastercard charges fees for all pre-authorizations.

Chargeback protection is in effect for 30 days after the authorization.

Unmarked Authorizations

An authorization is unmarked when the default authorization type is not set in your account and you do not include the

authIndicator

field in the authorization request. To set the default authorization type in your account, contact customer support.

Unmarked authorizations are supported only in the US, Canada, Latin America, and Asia Pacific. They are not supported in Europe, Russia, Middle East, and Africa.

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

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.

Requirements for Unmarked Authorizations

For an unmarked authorization:

The authorization amount must be greater than zero.

The authorization amount can be different from the final transaction amount.

Undefined Authorizations

An authorization is undefined when you set the default authorization type in your account to undefined and do not include the

authIndicator

field in the authorization request. To set the default authorization type in your account, contact customer support.

Undefined authorizations are supported only in the U.S., Canada, Latin America, and Asia Pacific. They are not supported in Europe, Russia, Middle East, and Africa.

Chargeback protection is in effect for seven days after the authorization.

Requirements for Undefined Authorizations

For an undefined authorization:

The authorization amount must be greater than zero.

The authorization amount can be different from the final transaction amount.

The authorization should not be cancelled after it is approved except when a system failure occurs.

The 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.

Required Fields for Final Authorizations

Use these required fields for final authorizations and preauthorizations.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

authIndicator: Set the value to
0
for preauthorizations, or to
1
for final authorizations.
Do not include this field for unmarked or undefined authorizations.
billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Simple Order Example: Final Authorizations

Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.{{WSDLVersion}}">
    <merchantID>testrest</merchantID>
    <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>
        <email>test@cybs.com</email>
    </billTo>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>1.02</grandTotalAmount>
    </purchaseTotals>
    <card>
        <accountNumber>4111111111111111</accountNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>2023</expirationYear>
        <cardType>001</cardType>
    </card>
    <ccAuthService run="true"/>
    <authIndicator>1</authIndicator>
</requestMessage>

Response to a Successful Request

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.142">
    <c:merchantReferenceCode>Postman-1691009216</c:merchantReferenceCode>
    <c:requestID>6910092160816328603011</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>1.02</c:amount>
        <c:authorizationCode>888888</c:authorizationCode>
        <c:avsCode>X</c:avsCode>
        <c:avsCodeRaw>I1</c:avsCodeRaw>
        <c:authorizedDateTime>2023-08-02T20:46:56Z</c:authorizedDateTime>
        <c:processorResponse>100</c:processorResponse>
        <c:reconciliationID>78194788VKQUQO9Q</c:reconciliationID>
        <c:paymentNetworkTransactionID>123456789619999</c:paymentNetworkTransactionID>
    </c:ccAuthReply>
    <c:card>
        <c:cardType>001</c:cardType>
    </c:card>
    <c:pos>
        <c:terminalID>111111</c:terminalID>
    </c:pos>
</c:replyMessage>

Authorization Reversal

This section provides the information about how to process an authorization reversal.

Reversing an authorization releases the hold on the customer’s payment card funds that the issuing bank placed when processing the authorization.

For a debit card or prepaid card in which only a partial amount was approved, the amount of the reversal must be the amount that was authorized, not the amount that was requested.

Supported Card Types

All supported card types can process reversals.

Endpoint

Set the

ccAuthReversalService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Authorization Reversal

ccAuthReversalService_authRequestID: Set this field to the request ID that was included in the authorization response message.
ccAuthReversalService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount: The amount of the reversal must be the same as the authorization amount that was included in the authorization response message. Do not use the amount that was requested in the authorization request message.

Simple Order Example: Processing an Authorization Reversal

Request

ccAuthReversalService_authRequestID=6522033834410167772169
ccAuthReversalService_run=true
merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
merchantID=Napa Valley Vacations
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=49.95

Response to a Successful Request

requestID=1019827520348290570293
merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
decision=ACCEPT
reasonCode=100
ccAuthReversalReply_amount=49.95
purchaseTotals_currency=USD
ccAuthReversalReply_reasonCode=100
ccAuthReversalReply_reconciliationID=1094820975023470

Time-Out Authorization Reversals

When you do not receive a response message after sending an authorization request, this feature enables you to reverse the authorization that you requested.

Wait 60 seconds before requesting a time-out authorization reversal.

Include the

merchantTransactionIdentifier

field in the original request for an authorization. The value of the merchant transaction ID must be unique for 180 days.

When the original transaction fails, the response message for the reversal request includes these fields:

originalTransaction_amount

originalTransaction_reasonCode

Requirements

Unless your processor supports authorization reversal after void (ARAV), time-out authorization reversals are supported only for authorizations that have not been captured and settled.

Required Fields for Processing a Time-Out Authorization Reversal

Use these required fields for processing a time-out authorization reversal.

ccAuthReversalService_authRequestID: Set this field to the request ID that was included in the authorization response message.
ccAuthReversalService_run: Set the value to
true
.
merchantReferenceCode
merchantTransactionIdentifier: Identifier that links the reversal request to the original request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount: The amount of the reversal must be the same as the authorization amount that was included in the authorization response message. Do not use the amount that was requested in the authorization request message.

Related Information

API Simple Order API Field Reference

Simple Order Example: Processing a Merchant-Initiated Authorization Reversal

Request

ccAuthReversalService_authRequestID=6522033834410167772169
ccAuthReversalService_run=true
merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
merchantTransactionIdentifier=987654321
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=49.95

Response to a Successful Request

requestID=1019827520348290570293
merchantReferenceCode=482046C3A7E94F5BD1FE3C66C
decision=ACCEPT
reasonCode=100
ccAuthReversalReply_amount=49.95
purchaseTotals_currency=USD
ccAuthReversalReply_reasonCode=100
ccAuthReversalReply_reconciliationID=1094820975023470

Sale

This section provides the information you need in order to process a sale transaction.

A sale combines an authorization and a capture into a single transaction.

Supported Card Types

All supported card types can process sales. .

Endpoint

Set the

ccAuthService_run

field to

true

, and the

ccCaptureService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing a Sale

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_merchantTaxID
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_cardType
card_cvNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator
ccAuthService_overridePaymentDetails
ccAuthService_overridePaymentMethod: Required for combo card transactions in Brazil.
ccAuthService_run: Set the value to
true
.
ccCaptureService_run: Set the value to
true
.
merchantCategoryCode
merchantID
postdatedTransaction_guaranteeAmount: Required for post-dated transactions with Mastercard in Brazil.
postdatedTransaction_guaranteeIndicator: Required for post-dated transactions with Mastercard in Brazil.
postdatedTransaction_settlementDate: Required for post-dated transactions with Mastercard in Brazil.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
transactionLocalDateTime

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing a Sale

Request

ccAuthService_run=true
ccCaptureService_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
billTo_email=jdoe@example.com
item_0_unitPrice=49.95
item_0_quantity=1
purchaseTotals_currency=USD
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
card_cardType=001

Response to a Successful Request

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
ccCaptureReply_amount=49.95
ccCaptureReply_reasonCode=100
ccCaptureReply_reconciliationID=1094820975023470

Sales with Payment Network Tokens

This section shows you how to successfully process a sale with payment network tokens.

Due to mandates from the Reserve Bank of India, Indian merchants cannot store personal account numbers (PAN). Use network tokens instead. For more information on network tokens, see Network Tokenization in the Token Management Service Developer Guide
.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Sales with Payment Network Tokens

Use these required fields for processing a sale with payment network tokens.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_email
billTo_firstName
billTo_lastName
billTo_street1
ccAuthService_networkTokenCryptogram
ccCaptureService_run: Set the value to
true
.
paymentNetworkToken_transactionType
purchaseTotals_currency
purchaseTotals_grandTotalAmount
token_expirationMonth
token_expirationYear

Related Information

API field reference guide for the Simple Order API

Optional Fields for Sales with Payment Network Tokens

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode: Required only for transactions in the U.S. and Canada.
billTo_state: Required only for transactions in the U.S. and Canada.
billTo_street1
card_accountNumber: Set to the token value that you received from the token service provider.
card_cardType: It is strongly recommended 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_expirationMonth: Set to the token expiration month that you received from the token service provider.
card_expirationYear: Set to the token expiration year that you received from the token service provider.
ccAuthService_cavv: For 3-D Secure in-app transactions for Visa
and JCB
, set to the 3-D Secure cryptogram. Otherwise, set to the network token cryptogram.
ccAuthService_commerceIndicator
ccAuthService_networkTokenCryptogram
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount or item_#_unitPrice
paymentNetworkToken_transactionType
paymentNetworkToken_requestorID: Required on Visa Platform Connect
ucaf_authenticationData: For Mastercard requests, set this field to the Identity Check cryptogram.
ucaf_collectionIndicator: For Mastercard requests, set the value to
2
.

Related Information

API field reference guide for the Simple Order API

Simple Order API Example: Authorizations with Payment Network Tokens

Request

<requestMessage>
    <merchantID>Foster_City_Flowers</merchantID>
    <merchantReferenceCode>12345678</merchantReferenceCode>
    <billTo>
        <firstName>Jane</firstName>
        <lastName>Smith</lastName>
        <street1>100 Main Street</street1>
        <street2>Suite 1234</street2>
        <city>Foster City</city>
        <state>CA</state>
        <postalCode>94404</postalCode>
        <country>US</country>
        <email>test@cybs.com</email>
    </billTo>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>16.00</grandTotalAmount>
    </purchaseTotals>
    <card>
        <accountNumber>4111111111111111</accountNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>2031</expirationYear>
    </card>
    <ccAuthService run="true">
        <networkTokenCryptogram>qE5juRwDzAUFBAkEHuWW9PiBkWv=</networkTokenCryptogram>
    </ccAuthService>
    <paymentNetworkToken>
        <transactionType>1</transactionType>
    </paymentNetworkToken>
</requestMessage>

Successful Response

<c:replyMessage>
    <c:merchantReferenceCode>Postman-1684858432</c:merchantReferenceCode>
    <c:requestID>6848584316126969103007</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>16.00</c:amount>
        <c:authorizationCode>888888</c:authorizationCode>
        <c:avsCode>X</c:avsCode>
        <c:avsCodeRaw>I1</c:avsCodeRaw>
        <c:authorizedDateTime>2023-05-23T16:13:51Z</c:authorizedDateTime>
        <c:processorResponse>100</c:processorResponse>
        <c:reconciliationID>78849228NHPFQCKD</c:reconciliationID>
        <c:paymentNetworkTransactionID>123456789619999</c:paymentNetworkTransactionID>
     </c:ccAuthReply>
     <c:card>
         <c:cardType>001</c:cardType>
     </c:card>
</c:replyMessage>

Captures

This section provides the information you need in order to capture an authorized transaction.

Supported Card Types

All supported card types can process captures. .

Endpoint

Set the

ccCaptureService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Capturing an Authorization

Use these required fields for capturing an authorization.

ccCaptureService_authRequestID
ccCaptureService_run
merchantID
merchantReferenceCode: Set the value to
merchant_ref_number
value used in corresponding authorization request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Simple Order Example: Capturing an Authorization

Request

ccCaptureService_authRequestID=6629978499572480812782
ccCaptureService_run=true
merchantID=npr_paymentech
merchantReferenceCode=TC42703-1
purchaseTotals_grandTotalAmount=100.00

Response to a Successful Request

ccCaptureReply_amount=100.00
ccCaptureReply_requestDateTime=2022-09-12T173947Z
decision=ACCEPT
merchantReferenceCode=TC42703-1
purchaseTotals_currency=USD
requestID=6630043878211258349460

Marketplace Captures with Foreign Retailers

Visa Platform Connect requires marketplaces to identify foreign retail transactions when the marketplace and issuer are in the European Economic Area (EEA), the U.K., and Gibraltar and the retailer is in a different country. For marketplace transactions, the marketplace is the merchant and the retailer is the sub-merchant. Marketplace foreign retail transactions are identified in the Business Center on the transactions details page.

The capture request data overrides the authorization request data.

Fields Specific to this Use Case

These fields are required for this use case:

invoiceHeader_merchantDescriptorCountry: Set this value to the marketplace country.
invoiceHeader_submerchantCountry: Set this value to the retailer country.

Endpoint

Set the

ccCaptureService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Capturing an Authorization with a Foreign Retailer

Use these required fields for capturing an authorization.

ccCaptureService_authRequestID
ccCaptureService_run
invoiceHeader_merchantDescriptorCountry: Set this field to the marketplace country.
invoiceHeader_submerchantCountry: Set this field to the retailer country.
merchantID
merchantReferenceCode: Set the value to
merchant_ref_number
value used in corresponding authorization request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Simple Order Example: Capturing a Marketplace Authorization with a Foreign Retailer

Request

ccCaptureService_authRequestID=6629978499572480812782
ccCaptureService_run=true
invoiceHeader_merchantDescriptorCountry=GB
invoiceHeader_submerchantCountry=AU
merchantID=abc123
merchantReferenceCode=TC42703-1
purchaseTotals_grandTotalAmount=100.00
purchaseTotals_currency=GBP

Response to a Successful Request

ccCaptureReply_amount=100.00
ccCaptureReply_requestDateTime=2024-09-12T173947Z
decision=ACCEPT
merchantReferenceCode=TC42703-1
purchaseTotals_currency=GBP
requestID=6630043878211258349460

Multiple Partial Captures

This section shows you how to process multiple partial captures for an authorization.

This feature enables you to request multiple partial captures for one authorization. A multiple partial capture allows you to incrementally settle authorizations over time. Ensure that the total amount of all the captures does not exceed the authorized amount.

Fields Specific to This Use Case

These API request fields and values are specific to this use case:

ccCaptureService_sequence
ccCaptureService_totalCount

Prerequisite

Contact customer support to have your account enabled for this feature.

Limitations

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

Endpoint

Set the

ccCaptureService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing Multiple Partial Captures

ccCaptureService_authRequestID
ccCaptureService_run: Set the value to
true
.
ccCaptureService_sequence: For the final capture request, set this field and
ccCaptureService_totalCount
to the same value.
ccCaptureService_totalCount: When you do not know the total number of captures that you are going to request, set this field to at least one more than the
ccCaptureService_sequence
field until you reach the final capture. For the final capture request, set this field and
ccCaptureService_sequence
to the same value.
merchantID
merchantReferenceCode: Set the value to
merchantReferenceCode
value used in corresponding authorization request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing Multiple Partial Captures

Request

<requestMessage
	xmlns="urn:schemas-cybersource-com:transaction-data-1.225">
	<merchantID>MERCHANT_ID</merchantID>
	<merchantReferenceCode>TC_FE_MD-1</merchantReferenceCode>
	<purchaseTotals>
		<currency>SAR</currency>
		<grandTotalAmount>10</grandTotalAmount>
	</purchaseTotals>
	<ccCaptureService run="true">
		<authRequestID>7429184781587007513700</authRequestID>
		<sequence>1</sequence>
		<totalCount>3</totalCount>
	</ccCaptureService>
</requestMessage>

Response to a Successful Request

<c:replyMessage
	xmlns:c="urn:schemas-cybersource-com:transaction-data-1.217">
	<c:merchantReferenceCode>TC_FE_MD-1</c:merchantReferenceCode>
	<c:requestID>7067731204117000415775</c:requestID>
	<c:decision>ACCEPT</c:decision>
	<c:reasonCode>100</c:reasonCode>
	<c:purchaseTotals>
		<c:currency>SAR</c:currency>
	</c:purchaseTotals>
	<c:ccCaptureReply>
		<c:reasonCode>100</c:reasonCode>
		<c:requestDateTime>2024-02-01T07:38:40Z</c:requestDateTime>
		<c:amount>100.00</c:amount>
		<c:reconciliationID>7067730865997000315775</c:reconciliationID>
		<c:authorizationCode>830SPG</c:authorizationCode>
		<c:processorResponse>00</c:processorResponse>
	</c:ccCaptureReply>
</c:replyMessage>

Forced Captures

This feature allows merchants to process authorizations obtained through an organization other than Cybersource. For example, a merchant might call their processor to request a manual authorization, at which point they can request a forced capture of the authorization.

A manual authorization cannot be captured for more than the original authorization amount, and the authorization expires after seven days.

Supported Acquirers

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

Supported Services

Authorization

Required Fields for Forced Captures

Use these required fields for processing forced captures.

authIndicator: Set the value to
0
for preauthorizations, or to
1
for final authorizations..
billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Forced Captures

Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.{{WSDLVersion}}">
    <merchantID>testrest</merchantID>
    <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>
        <email>test@cybs.com</email>
    </billTo>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>1.02</grandTotalAmount>
    </purchaseTotals>
    <card>
        <accountNumber>4111111111111111</accountNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>2023</expirationYear>
        <cardType>001</cardType>
    </card>
    <ccAuthService run="true">
        <authType>verbal</authType>
        <verbalAuthCode>ABC123</verbalAuthCode>
    </ccAuthService>
</requestMessage>

Response to a Successful Request

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.142">
    <c:merchantReferenceCode>Postman-1691513134</c:merchantReferenceCode>
    <c:requestID>6915131335966844703009</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>1.02</c:amount>
        <c:authorizationCode>ABC123</c:authorizationCode>
        <c:authorizedDateTime>2023-08-08T16:45:33Z</c:authorizedDateTime>
    </c:ccAuthReply>
    <c:card>
         <c:cardType>001</c:cardType>
    </c:card>
</c:replyMessage>

Follow-On Credits

This section provides the information you need in order to process a

follow-on credit

, which is linked to a

capture or

sale.

You must request a

follow-on credit

within 180 days of the authorization.

When your account is enabled for credit authorizations, also known as purchase return authorizations, Cybersource authenticates the card and customer during a credit request. Every credit request is automatically authorized.

Credit authorization results are returned in these response fields:

ccCreditReply_authorizationCode

ccCreditReply_paymentNetworkTransactionID

ccCreditReply_processorResponse

When you request a void for the credit and the credit is voided. If your account is enabled for credit authorizations, the credit authorization is also reversed.

Supported Card Types

All supported card types can process

follow-on credits

. For a list of all supported card types, see Payment Processors.

Endpoint

Set the

ccCreditService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing a
Follow-On Credit

Use these required fields for processing a

follow-on credit

.

ccCreditService_captureRequestID
ccCreditService_run: Set the value to
true
.
merchantID
merchantReferenceCode: Set to
merchantReferenceCode
value used in corresponding capture or sale request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing a Follow-On Credit

Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.86">
  <merchantID>merchantID</merchantID>
  <merchantReferenceCode>merchantRefCode</merchantReferenceCode>
  <purchaseTotals>
    <currency>USD</currency>
    <grandTotalAmount>1.01</grandTotalAmount>
  </purchaseTotals>
  <ccCreditService run="true">
    <captureRequestID>captureRequestID</captureRequestID>
  </ccCreditService>
</requestMessage>

Response to a Successful Request

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.86">
  <c:merchantReferenceCode>Postman-1666641056</c:merchantReferenceCode>
  <c:requestID>6666410568976150003010</c:requestID>
  <c:decision>ACCEPT</c:decision>
  <c:reasonCode>100</c:reasonCode>
  <c:purchaseTotals>
    <c:currency>USD</c:currency>
  </c:purchaseTotals>
  <c:ccCreditReply>
    <c:reasonCode>100</c:reasonCode>
    <c:requestDateTime>2022-10-24T19:50:57Z</c:requestDateTime>
    <c:amount>1.01</c:amount>
    <c:reconciliationID>6691571329CM5P99</c:reconciliationID>
    <c:authorizationCode>831111</c:authorizationCode>
    <c:processorResponse>00</c:processorResponse>
    <c:paymentNetworkTransactionID>222222222222222</c:paymentNetwork>
  </c:ccCreditReply>
</c:replyMessage>

Stand-Alone Credits

This section shows you how to process a

stand-alone

credit, which is not linked to a capture or sale. There is no time limit for requesting a

stand-alone

credit.

When your account is enabled for credit authorizations, also known as purchase return authorizations, Cybersource authenticates the card and customer during a credit request. Every credit request is automatically authorized.

Credit authorization results are returned in these response fields:

ccCreditReply_authorizationCode

ccCreditReply_paymentNetworkTransactionID

ccCreditReply_processorResponse

When you request a void for the credit and the credit is voided. If your account is enabled for credit authorizations, the credit authorization is also reversed.

Endpoint

Set the

ccCreditService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing a
Stand-Alone
Credit

Use these required fields for processing a

stand-alone

credit.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccCreditService: Set the value to
true
. For example
ccCreditService run="true"
.
merchantID
merchantReferenceCode: Set to
merchantReferenceCode
value used in corresponding capture request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Simple Order Example: Processing a Stand-Alone Credit

Request

<requestMessage>
    <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>
        <email>null@cybersource.com</email>
    </billTo>
    <card>
        <accountNumber>4111111111111111</accountNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>2023</expirationYear>
    </card>
    <merchantID>lrsebctest</merchantID>
    <merchantReferenceCode>Postman-1666381004</merchantReferenceCode>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>1.01</grandTotalAmount>
    </purchaseTotals>
    <ccCreditService run="true"/>
</requestMessage>

Response to a Successful Request

<c:replyMessge>
    <c:merchantReferenceCode>Postman-1666374834</c:merchantReferenceCode>
    <c:requestID>6663748348516429203007</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>1.01</c:amount>
        <c:authorizationCode>888888</c:authorizationCode>
        <c:avsCode>X</c:avsCode>
        <c:avsCodeRaw>I1</c:avsCodeRaw>
        <c:authorizedDateTime>2022-10-21T17:53:54Z</c:authorizedDateTime>
        <c:processorResponse>100</c:processorResponse>
        <c:reconciliationID>66737280B9CGUCCP</c:reconciliationID>
        <c:paymentNetworkTransactionID>123456789619999</c:paymentNetworkTransactionID>
    </c:ccAuthReply>
    <c:card>
        <c:cardType>001</c:cardType>
    </c:card>
</c:replyMessge>

Void for a Capture or Credit

This section describes how to void a capture or credit that was submitted but not yet processed by the processor.

Endpoints

Void a Capture

Void a Credit

Set the

VoidService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Voiding a Capture or Credit

merchantID
merchantReferenceCode
voidService_voidRequestID: Set this field to the request ID that was included in the authorization response message.
voidService_run: Set the value to
true
.

Simple Order API Example: Voiding a Capture or Credit

Request

merchantID=Napa Valley Vacations
merchantReferenceCode=482046C3A7E94F5
voidService_run
voidService_voidRequestID=6522033834410167772169

Response to a Successful Request

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

Time-Out Voids for a Capture, Sale,
Follow-On Credit
, or
Stand-Alone Credit

When you do not receive a response message after requesting a capture, sale,

follow-on credit

, or

stand-alone credit

, this feature enables you to void the transaction that you requested.

Include the

merchantTransactionIdentifier

field in the original request for a capture, sale,

follow-on credit

, or

stand-alone credit

. The value of the merchant transaction ID must be unique for 180 days.

When the original transaction fails, the response message for the reversal request includes these fields:

originalTransaction_amount

originalTransaction_reasonCode

Endpoint

Required Fields for a Time-Out Void for a Capture, Sale,
Follow-On Credit
, or
Stand-Alone Credit

merchantID
merchantReferenceCode
merchantTransactionIdentifier: Identifier that links the reversal request to the original request.
voidService_voidRequestID: Set this field to the request ID that was included in the authorization response message.
voidService_run: Set the value to
true
.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Time-Out Void for a Capture, Sale, Follow-On Credit, or Stand-Alone Credit

Request

merchantID=Napa Valley Vacations
merchantReferenceCode=482046C3A7E94F5
voidService_run
voidService_voidRequestID=6522033834410167772169

Response to a Successful Request

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

Debit and Prepaid Card Processing

This section shows you how to process authorizations that use a debit or prepaid card.

Requirements

In Canada, to process domestic debit transactions on Visa Platform Connect with Mastercard, you must contact customer support to have your account configured for this feature.

When using the Simple Order API in XML format, partial authorizations or balance responses require the XML schema version 1.52 or later.

Related Information

See Debit and Prepaid Card Payments for a description of the debit or prepaid card transactions you can process.

Processing Debit and Prepaid Authorizations

This section shows you how to process an authorization using debit and prepaid cards.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing Debit and Prepaid Authorizations

Use these required fields for processing debit and prepaid authorizations.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Country Specific Required Fields to Process Debit and Prepaid Authorizations

Use these country-specific required fields to process a debit or prepaid authorization.

Argentina

billTo_merchantTaxID: Required for Mastercard transactions.

transactionLocalDateTime: Required in Argentina when the time zone is not included in your account. Otherwise, this field is optional.

Brazil

billTo_personalID: Required for combo card transactions.
ccAuthService_overridePaymentDetails: Required for combo card line-of-credit and prepaid-card transactions.

Chile

billTo_merchantTaxID: Required for Mastercard transactions.

Paraguay

billTo_merchantTaxID: Required for Mastercard transactions.

Saudi Arabia

transactionMode

Taiwan

Name: card_hashedAccountNumber

Related Information

API field reference guide for the Simple Order API

Optional Field for Processing Debit and Prepaid Authorizations

You can use this optional field to include additional information when processing debit and prepaid authorizations.

linkToRequest: Set this field to the request ID that was returned in the response message from the original authorization request.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing Debit and Prepaid Authorizations

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_postalCode=40500
billTo_state=CA
billTo_street1=901 Metro Center Blvd
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2031
ccAuthService_run=true
merchant_id=pa_ctv_sg101
merchantReferenceCode=rts_6595481893301034778276
purchaseTotals_currency=usd
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

additionalData=ABC
ccAuthReply_amount=100.00
ccAuthReply_avsCode=Y
ccAuthReply_authorizationCode=831000
ccAuthReply_processorResponse=00
ccAuthReply_authorizedDateTime=2022-08-30T165039Z
ccAuthReply_avsCodeRaw=Y
ccAuthReply_cavvResponseCode=2
ccAuthReply_cavvResponseCodeRaw=2
ccAuthReply_merchantAdviceCode=01
ccAuthReply_merchantAdviceCodeRaw=M001
ccAuthReply_paymentNetworkTransactionID=016153570198200
ccAuthReply_reconciliationReferenceNumber=224216876457
apAuthReply_reconciliationID=6618782389070178232890
card_cardType=001
payerAuthEnrollReply_cardTypeName=VISA
purchaseTotals_currency=usd
merchantReferenceCode=rts_6595481893301034778276
receiptNumber=876457
requestID=6618782389070178232890

Enabling Debit and Prepaid Partial Authorizations

Partial authorizations and balance responses are special features that are available for debit cards and prepaid cards. This section shows you how to enable partial authorizations for a specific transaction.

To globally process domestic debit transactions on Visa Platform Connect with Mastercard in Canada, you must contact customer support to have your account configured for this feature.

You must use version 1.52 or later of the XML schema to implement partial authorizations or balance responses.

Field Specific to this Use Case

Include this field in addition to the fields required for a standard authorization request:

Indicate that this request is a partial authorization.

Set the

ccAuthService_partialAuthIndicator

to

true

.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Enabling Debit and Prepaid Partial Authorizations

Use these required fields for enabling debit and prepaid partial authorizations.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_partialAuthIndicator: Set the value to
true
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Optional Field for Enabling Debit and Prepaid Partial Authorizations

You can use these optional fields to include additional information when enabling debit and prepaid partial authorizations.

linkToRequest: Set this field to the request ID that was returned in the response message from the original authorization request.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Enabling Debit and Prepaid Partial Authorizations

Request

billTo_street1=201 S. Division St
billTo_city=Ann Arbor
billTo_country=US
billTo_state=MI
billTo_postalCode=48104-2201
billTo_email=test@cybs.com
billTo_firstname=John
billTo_lastname=Deo
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=5555555555554444
ccAuthService_partialAuthIndicator=true
merchant_id=pa_ctv_sg101
merchantReferenceCode=TC50171_3
purchaseTotals_currency=usd
purchaseTotals_grandTotalAmount=1000.00

Response to a Successful Request

apCaptureService_authRequestID=6618807769750178232890
apAuthReply_reconciliationID=6618807769750178232890
card_cardType=002
ccAuthReply_amount=1000.00
ccAuthReply_avsCode=Y
ccAuthReply_authorizationCode=831000
ccAuthReply_authorizedDateTime=2022-08-30T173257Z
ccAuthReply_avsCodeRaw=Y
ccAuthReply_cavvResponseCode=2
ccAuthReply_cavvResponseCodeRaw=2
ccAuthReply_merchantAdviceCode=01
ccAuthReply_merchantAdviceCodeRaw=M001
ccAuthReply_processorResponse=00
ccAuthReply_reconciliationReferenceNumber=224217876503
ccCreditReply_paymentNetworkTransactionID=MCC9689130830
merchantReferenceCode=TC50171_3
payerAuthEnrollReply_cardTypeName=MASTERCARD
purchaseTotals_currency=usd
receiptNumber=876503
requestID=6618807769750178232890

Disabling Debit and Prepaid Partial Authorizations

This topic shows you how to successfully disable partial authorizations for specific transactions.

Field Specific to this Use Case

Include this field in addition to the fields required for a standard authorization request:

Indicate that this request is not a partial authorization.

Set the

ccAuthService_partialAuthIndicator

to

false

.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Field for Disabling Debit and Prepaid Partial Authorizations

Use these required fields for disabling debit and prepaid partial authorizations.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_partialAuthIndicator: Set the value to
false
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Optional Field for Disabling Debit and Prepaid Partial Authorizations

You can use this optional field to include additional information when disabling debit and prepaid partial authorizations.

linkToRequest: Set this field to the request ID that was returned in the response message from the original authorization request.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Disabling Debit and Prepaid Partial Authorizations

Request

billTo_street1=201 S. Division St
billTo_city=Ann Arbor
billTo_country=US
billTo_state=MI
billTo_postalCode=48104-2201
billTo_email=test@cybs.com
billTo_firstname=John
billTo_lastname=Deo
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=5555555555554444
ccAuthService_partialAuthIndicator=false
merchant_id=pa_ctv_sg101
merchantReferenceCode=TC50171_3
purchaseTotals_currency=usd
purchaseTotals_grandTotalAmount=1000.00

Response to a Successful Request

apCaptureService_authRequestID=6643889552520668668655
apAuthReply_reconciliationID=6643889552520668668655
card_cardType=002
ccAuthReply_amount=1000.00
ccAuthReply_avsCode=Y
ccAuthReply_authorizationCode=831000
ccAuthReply_authorizedDateTime=2022-09-28T173257Z
ccAuthReply_avsCodeRaw=Y
ccAuthReply_cavvResponseCode=2
ccAuthReply_cavvResponseCodeRaw=2
ccAuthReply_merchantAdviceCode=01
ccAuthReply_merchantAdviceCodeRaw=M001
ccAuthReply_processorResponse=00
ccAuthReply_reconciliationReferenceNumber=227118876340
ccCreditReply_paymentNetworkTransactionID=MCC8605090928
merchantReferenceCode=TC50171_3
payerAuthEnrollReply_cardTypeName=MASTERCARD
purchaseTotals_currency=usd
receiptNumber=876340
requestID=6618807769750178232890

Airline Data Processing

This section describes how to process airline payments.

Requirement

When you are ready to go live with airline data processing, contact Cybersource Customer Support to have your account configured to process airline data. If your account is not enabled, and you try to send airline transactions, you will receive an error for invalid data.

Related Information

See Airline Data for information about and requirements for processing payments that include airline data.

See Airline Data Reference Information for a list and description of the different document type and ancillary service category codes that are used when processing payments that include airline data.

Airline Travel Legs

Some processors require travel legs in the API service request, even for direct flights. This section describes how to successfully include travel legs in an API request.

Using Travel Legs

To include travel legs in an airline transaction, include one or more

airlineData_leg_#_

fields, starting with the

airlineData_leg_0_

fields.

Direct flights only use the

airlineData_leg_0_

fields.

For multiple leg trips, the

airlineData_leg_#_

fields must start at 0, and you must use consecutive numbers for the additional legs.

If you skip a number, Cybersource ignores the legs that follow the skipped number.

For example, these three travel legs are valid:

<leg id="0">
    <carrierCode>XX</carrierCode>
</leg>
<leg id="1">
    <carrierCode>XZ</carrierCode>
</leg>
<leg id="2">
    <carrierCode>XX</carrier<code>
</leg>

Travel Leg Limitations

Some processors limit the number of travel legs for each trip based on the card type.

Authorize an Airline Ticket Payment

This section describes how to process an airline authorization.

Authorization Restrictions

Ticket purchases that include multiple passengers may be included in a single authorization request, but you must make separate capture requests for every passenger.

If any ancillary purchases are made at the same time as the ticket purchase, you may include all items in a single authorization request, but you must separate the ancillary and ticket purchases into their own capture requests.

If any ancillary purchases are made not at the same time as the ticket purchase, you must send separate authorization and capture requests for the ancillary and ticket purchases.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing an Airline Payment

Include these required fields for authorizing an airline payment.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_industryDatatype: Set the value to
airline
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Simple Order Example: Authorizing an Airline Payment

Use this example as a reference for authorizing an airline payment.

Request

<requestMessage>
    <merchantID>merchantID</merchantID>
    <merchantReferenceCode>TC42703-1</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>
        <email>customer_email=null@cybersource.com</email>
    </billTo>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>1.02</grandTotalAmount>
    </purchaseTotals>
    <card>
        <accountNumber>4111111111111111</accountNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>2023</expirationYear>
        <cardType>001</cardType>
    </card>
    <ccAuthService run="true">
        <industryDatatype>airline</industryDatatype>
    </ccAuthService>
<requestMessage>

Response to a Successful Request

<c:replyMessage>
    <c:merchantReferenceCode>TC42703-1</c:merchantReferenceCode>
    <c:requestID>6823465362086241603012</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>1.02</c:amount>
        <c:authorizationCode>888888</c:authorizationCode>
        <c:avsCode>X</c:avsCode>
        <c:avsCodeRaw>I1</c:avsCodeRaw>
        <c:authorizedDateTime>2023-04-24T14:28:56Z</c:authorizedDateTime>
        <c:processorResponse>100</c:processorResponse>
        <c:reconciliationID>74375324VGM5S0S6</c:reconciliationID>
        <c:paymentNetworkTransactionID>123456789619999</c:paymentNetworkTransactionID>
    </c:ccAuthReply>
    <c:card>
        <c:cardType>001</c:cardType>
    </c:card>
    <c:pos>
        <c:terminalID>111111</c:terminalID>
    </c:pos>
</c:replyMessage>

Captures for Ticket Purchases

This section describes how to capture an airline payment for ticket purchases.

Captures for ticket purchases must be made separately from captures for ancillary purchases. For more information about how to capture an ancillary purchase, see Captures for Ancillary Purchases.

Travel Legs

You can use travel leg fields for trips that have multiple legs. For more information on how to use travel leg fields, see Airline Data.

Leg Limitations

Visa Platform Connect limits the maximum number of legs for each trip based on card type. This table describes the maximum number of legs for each trip based on card type.

`Visa Platform Connect` Leg Limitations
Supported Card Types	Maximum Number of Trip Legs
American Express	4
Discover	4
Mastercard	4
Visa	4

Endpoint

Set the

ccCaptureService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Capturing an Airline Payment

Include these required fields to capture an airline payment for ticket purchases.

ccCaptureService_authRequestID
ccCaptureService_run
merchantID
merchantReferenceCode: Set to the
merchant_ref_number
value used in corresponding authorization request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
ccCaptureService_industryDatatype: Set the value to
airline
.

Card-Specific Field to Capture an Airline Payment

This section includes card-specific information.

Mastercard

Use this card-specific field in addition to the required fields when capturing an authorization with a Mastercard.

airlineData_ticketIssuerCode

Optional Fields for Capturing an Airline Payment

You can use these optional fields to include additional information when capturing an airline payment.

airlineData_agentCode
airlineData_agentName
airlineData_arrivalDate
airlineData_carrierName
airlineData_clearingCount
airlineData_clearingSequence
airlineData_creditReasonIndicator
airlineData_customerCode
airlineData_documentType: For a list of possible values, see Airline Document Type Codes.
airlineData_electronicTicket
airlineData_exchangeTicketAmount
airlineData_exchangeTicketFee
airlineData_numberOfPassengers
airlineData_passengerName
airlineData_planNumber
airlineData_purchaseType
airlineData_reservationSystem
airlineData_restrictedTicketIndicator
airlineData_ticketIssueDate
airlineData_ticketIssuerCity
airlineData_ticketIssuerCode
airlineData_ticketNumber
airlineData_ticketRestrictionText
airlineData_ticketUpdateIndicator
airlineData_totalClearingAmount
airlineData_totalFee
airlineData_leg_#_arrivalTime
airlineData_leg_#_arrivalTimeSegment
airlineData_leg_#_carrierCode
airlineData_leg_#_class
airlineData_leg_#_conjunctionTicket
airlineData_leg_#_couponNumber
airlineData_leg_#_departureDate
airlineData_leg_#_departureTime
airlineData_leg_#_departureTimeSegment
airlineData_leg_#_destination
airlineData_leg_#_endorsementsRestrictions
airlineData_leg_#_exchangeTicket
airlineData_leg_#_fare
airlineData_leg_#_fareBasis
airlineData_leg_#_fee
airlineData_leg_#_flightNumber
airlineData_leg_#_originatingAirportCode
airlineData_leg_#_stopoverCode
airlineData_leg_#_tax
item_#_taxAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Capturing an Airline Payment

Request

<requestMessage>
    <merchantID>World Wide Travel</merchantID>
    <merchantReferenceCode>R98TV09EN200W</merchantReferenceCode>
    <purchaseTotals> 
        <currency>USD</currency>
        <grandTotalAmount>204.78</grandTotalAmount>
    </purchaseTotals>
    <ccCaptureService run="true">
        <authRequestID>0839543530000172034078</authRequestID>
        <industryDatatype>airline</industryDatatype>
    </ccCaptureService>
    <airlineData>
        <agentCode>98222147</agentCode>
        <agentName>Cyber Vacations</agentName>
        <ticketNumber>02721187251</ticketNumber>
        <restrictedTicketIndicator>0</restrictedTicketIndicator>
        <passengerName>Johnny Smith</passengerName>
        <leg id="0">
            <carrierCode>AA</carrierCode>
            <originatingAirportCode>SJC</originatingAirportCode>
            <departureDate>121511</departureDate>
            <destination>SEA</destination>
            <fareBasis>HL7WNR</fareBasis>
            <couponNumber>1</couponNumber>
            <departureTime>0931</departureTime>
            <departureTimeSegment>A</departureTimeSegment>
            <arrivalTime>1131</arrivalTime>
            <arrivalTimeSegment>A</arrivalTimeSegment>
        </leg>
        <leg id="1">
            <carrierCode>AA</carrierCode>
            <originatingAirportCode>SEA</originatingAirportCode>
            <departureDate>122011</departureDate>
            <destination>SJC</destination>
            <fareBasis>HL7WNR</fareBasis>
            <couponNumber>2</couponNumber>
            <departureTime>1625</departureTime>
            <departureTimeSegment>P</departureTimeSegment>
            <arrivalTime>1837</arrivalTime>
            <arrivalTimeSegment>P</arrivalTimeSegment>
        </leg>
    </airlineData>
</requestMessage>

Response to a Successful Request

<c:replyMessage>
    <c:merchantReferenceCode>R98TV09EN200W</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:ccCaptureReply>
        <c:reasonCode>100</c:reasonCode>
        <c:amount>204.78</c:amount>
        <c:reconciliationID>1094820975023470</c:reconciliationID>
        <c:enhancedDataEnabled>y</c:enhancedDataEnabled>
    </c:ccCaptureReply>
</replyMessage>

Captures for Ancillary Purchases

This section describes how to capture an airline payment for ancillary purchases.

Ancillary purchases are any additional services, such as baggage, meals, and paid seats, that your customers can purchase. Captures for ancillary purchases must be made separately from captures for ticket purchases.

Endpoint

Set the

ccCaptureService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Capturing an Authorization for Ancillary Purchases

Include these required fields to capture an airline payment for ancillary purchases.

ccCaptureService_authRequestID
ccCaptureService_run: Set the value to
true
.
merchantID
merchantReferenceCode: Set to the
merchant_ref_number
value used in corresponding authorization request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
industry_datatype

Related Information

API field reference guide for the Simple Order API

Ancillary Fields for Capturing an Authorization for an Ancillary Purchase

Choose from these optional ancillary fields to add additional information when capturing an ancillary purchase.

ancillaryData_connectedTicketNumber
ancillaryData_creditReasonIndicator
ancillaryData_passengerName
ancillaryData_service_#_categoryCode: For a list of possible values, see Ancillary Service Category Codes.
ancillaryData_service_#_subcategoryCode
ancillaryData_ticketNumber

Simple Order Example: Capturing an Authorization for an Ancillary Purchase

Use this example as a reference for capturing an authorization for ancillary purchases.

Request

<requestMessage>
    <merchantID>World Wide Travel</merchantID>
    <merchantReferenceCode>R98TV09EN200W</merchantReferenceCode>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>204.78</grandTotalAmount>
    </purchaseTotals>
    <ccCaptureService run="true">
        <authRequestID>0839543530000172034078</authRequestID>
        <industryDatatype>airline</industryDatatype>
    </ccCaptureService>
    <ancillaryData>
        <ticketNumber>123456789123456</ticketNumber>
        <passengerName>Jane Smith</passengerName>
        <connectedTicketNumber>98765432112345</connectedTicketNumber>
        <creditReasonIndicator>A</creditReasonIndicator>
        <service sequenceNumber="0">
            <categoryCode>MEAL</categoryCode>
            <subCategoryCode>SPM</subCategoryCode>
        </service>
        <service sequenceNumber="1">
            <categoryCode>ENTM</categoryCode>
            <subCategoryCode>DTV</subCategoryCode>
        </service>
    </ancillaryData>
</requestMessage>

Response to a Successful Request

<c:replyMessage>
    <c:requestID>4250238442125000001540</c:requestID>
    <c:decision>ACCEPT</c:decision>
    <c:reasonCode>100</c:reasonCode>
    <c:merchantReferenceCode>R98TV09EN200W</c:merchantReferenceCode>
    <c:purchaseTotals>
        <c:currency>USD</c:currency>
    </c:purchaseTotals>
    <c:ccCaptureReply>
        <c:reasonCode>100</c:reasonCode>
        <c:amount>204.78</c:amount>
        <c:reconciliationID>1094820975023470</c:reconciliationID>
        <c:enhancedDataEnabled>y</c:enhancedDataEnabled>
    </c:ccCaptureReply>
</c:replyMessage>

Follow-On Credits

This topic describes how to process an airline follow-on credit.

This service returns the funds used in the initial capture and requires the original capture ID.

Endpoint

Set the

ccCreditService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Airline
Follow-On Credit

Include these required fields to process an airline follow-on credit.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccCreditService_captureRequestID
ccCreditService_run: Set the value to
true
. For example
ccCreditService run="true"
.
merchantID
merchantReferenceCode: Set to the
merchant_ref_number
value used in corresponding capture request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Optional Fields for Processing an Airline
Follow-On Credit

This section includes these types of optional fields for an airline

follow-on credit

:

General Optional Fields

Optional Fields for Ticket Purchases

Optional Fields for Ancillary Purchases

General Optional Fields

You can use these optional fields to include additional information in any airline purchase.

airlineData_agentCode
airlineData_agentName
airlineData_arrivalDate
airlineData_carrierName
airlineData_clearingCount
airlineData_clearingSequence
airlineData_creditReasonIndicator
airlineData_customerCode
airlineData_documentType: For a list of possible values, see Airline Document Type Codes.
airlineData_electronicTicket
airlineData_exchangeTicketAmount
airlineData_exchangeTicketFee
airlineData_numberOfPassengers
airlineData_passengerName
airlineData_planNumber
airlineData_purchaseType
airlineData_reservationSystem
airlineData_restrictedTicketIndicator
airlineData_ticketIssueDate
airlineData_ticketIssuerCity
airlineData_ticketNumber
airlineData_ticketRestrictionText
airlineData_ticketUpdateIndicator
airlineData_totalClearingAmount
airlineData_totalFee

Airline Optional Fields for Ticket Purchases

You can use these optional fields to include additional information when requesting an airline

stand-alone credit

for a ticket purchase.

Ancillary Optional Fields

You can use these optional fields to include additional information when requesting an airline

stand-alone credit

for an ancillary purchase.

ancillaryData_connectedTicketNumber
ancillaryData_creditReasonIndicator
ancillaryData_passengerName
ancillaryData_service_#_categoryCode: For a list of possible values, see Ancillary Service Category Codes.
ancillaryData_service_#_subcategoryCode
ancillaryData_ticketNumber

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Airline Follow-On Credit

Use this example as a reference for processing an airline follow-on credit.

Request

<requestMessage>
    <merchantID>merchantID</merchantID>
    <merchantReferenceCode>merchantRefCode</merchantReferenceCode>
    <purchaseTotals>
        <currency>USD</currency>
        <grandTotalAmount>1.01</grandTotalAmount>
    </purchaseTotals>
    <ccCreditService run="true">
        <captureRequestID>captureRequestID</captureRequestID>
    </ccCreditService>
</requestMessage>

Response to a Successful Request

<c:replyMessage>
    <c:merchantReferenceCode>Postman-1666641056</c:merchantReferenceCode>
    <c:requestID>6666410568976150003010</c:requestID>
    <c:decision>ACCEPT</c:decision>
    <c:reasonCode>100</c:reasonCode>
    <c:purchaseTotals>
        <c:currency>USD</c:currency>
    </c:purchaseTotals>
    <c:ccCreditReply>
        <c:reasonCode>100</c:reasonCode>
        <c:requestDateTime>2022-10-24T19:50:57Z</c:requestDateTime>
        <c:amount>1.01</c:amount>
        <c:reconciliationID>6691571329CM5P99</c:reconciliationID>
    </c:ccCreditReply>
</c:replyMessage>

Issue a
Stand-Alone
Credit

This topic describes how to process an airline stand-alone credit.

This service distributes funds without requiring a capture ID.

All fields used in the original transaction must be included in your request.

Endpoint

Set the

ccCreditService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Airline
Stand-Alone Credit

Include these required fields to process an airline stand-alone credit.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccCreditService_captureRequestID
ccCreditService_run: Set the value to
true
. For example
ccCreditService run="true"
.
merchantID
merchantReferenceCode: Set to the
merchant_ref_number
value used in corresponding capture request.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
ccCreditService_industryDatatype: Set the value to
airline
.

Optional Fields for Processing an Airline
Stand-Alone Credit

This section includes these types of optional fields for an airline

stand-alone credit

:

General Optional Fields

Optional Fields for Ticket Purchases

Optional Fields for Ancillary Purchases

General Optional Fields

You can use these optional fields to include additional information in any airline purchase.

airlineData_agentCode
airlineData_agentName
airlineData_arrivalDate
airlineData_carrierName
airlineData_clearingCount
airlineData_clearingSequence
airlineData_creditReasonIndicator
airlineData_customerCode
airlineData_documentType: For a list of possible values, see Airline Document Type Codes.
airlineData_electronicTicket
airlineData_exchangeTicketAmount
airlineData_exchangeTicketFee
airlineData_numberOfPassengers
airlineData_passengerName
airlineData_planNumber
airlineData_purchaseType
airlineData_reservationSystem
airlineData_restrictedTicketIndicator
airlineData_ticketIssueDate
airlineData_ticketIssuerCity
airlineData_ticketNumber
airlineData_ticketRestrictionText
airlineData_ticketUpdateIndicator
airlineData_totalClearingAmount
airlineData_totalFee

Airline Optional Fields for Ticket Purchases

You can use these optional fields to include additional information when requesting an airline

stand-alone credit

for a ticket purchase.

Ancillary Optional Fields

You can use these optional fields to include additional information when requesting an airline

stand-alone credit

for an ancillary purchase.

ancillaryData_connectedTicketNumber
ancillaryData_creditReasonIndicator
ancillaryData_passengerName
ancillaryData_service_#_categoryCode: For a list of possible values, see Ancillary Service Category Codes.
ancillaryData_service_#_subcategoryCode
ancillaryData_ticketNumber

Simple Order Example: Processing an Airline Stand-Alone Credit

Request

<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>
     <email>customer_email=null@cybersource.com</email>
 </billTo>
 <card>
     <accountNumber>4111111111111111</accountNumber>
     <expirationMonth>12</expirationMonth>
     <expirationYear>2023</expirationYear>
 </card>
 <merchantID>lrsebctest</merchantID>
 <merchantReferenceCode>Postman-1666381004</merchantReferenceCode>
 <purchaseTotals>
     <currency>USD</currency>
     <grandTotalAmount>1.01</grandTotalAmount>
 </purchaseTotals>
 <ccCreditService run="true">
     <captureRequestID>6663700818566565103010</captureRequestID>
 </ccCreditService>

Response to a Successful Request

<merchantReferenceCode>Postman-1666374834</merchantReferenceCode>
<requestID>6663748348516429203007</requestID>
<decision>ACCEPT</decision>
<reasonCode>100</reasonCode>
<purchaseTotals>
    <currency>USD</currency>
</purchaseTotals>
<ccAuthReply>
    <reasonCode>100</reasonCode>
    <amount>1.01</amount>
    <authorizationCode>888888</authorizationCode>
    <avsCode>X</avsCode><avsCodeRaw>I1</avsCodeRaw>
    <authorizedDateTime>2022-10-21T17:53:54Z</authorizedDateTime>
    <processorResponse>100</processorResponse>
    <reconciliationID>66737280B9CGUCCP</reconciliationID>
    <paymentNetworkTransactionID>123456789619999</paymentNetworkTransactionID>
</ccAuthReply>
<card>
    <cardType>001</cardType>
</card>
<pos>
    <terminalID>111111</terminalID>
</pos>

Japanese Payment Options Processing

This section shows you how to process an authorization with Japanese payment options (JPO).

JPO supports these payment methods:

Single payment

Bonus payment

Installment payment

Revolving payment

Combination of bonus payment and installment payment

Requirements

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Related Information

See Japanese Payment Options for a description of JPO payments.

Authorize a Single Payment with Japanese Payment Options

This section shows you how to process an authorization of a single payment with Japanese Payment Options (JPO).

Limitations

The only supported acquirer is Sumitomo Mitsui Card Co.

The payment must use a Visa payment card issued in Japan, and the only supported acquirer is Sumitomo Mitsui Card Co.

Prerequisites

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing a Single Payment Using the JPO Method

Use these required fields for authorizing a single payment using the JPO method.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

bill_city
bill_country
billTo_email
billTo_firstname
billTo_lastname
billTo_postalCode
billTo_state
billTo_street
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
jpo_businessNameAlpha
jpo_businessNameJapanese: Business name in kanji characters.
jpo_businessNameKanji
jpo_jccaTerminalID: Required for card-present transactions. Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Authorizing a JPO Single Payment

Request

merchantID=npr_jcn8
merchantReferenceCode=TC42703-1
jpo_businessNameAlphaNumeric=MyStore
jpo_businessNameJapanese=我社
jpo_businessNameKatakana=わが社の場合
billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstName=John
billTo_lastName=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street=201 S. Division St.
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2024
purchaseTotals_currency=jpy
purchaseTotals_grandTotalAmount=100.00

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=usd
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_forwardCode=Sumitomo
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Authorize a Bonus Payment with Japanese Payment Options

This section shows you how to process an authorization of a bonus payment with Japanese Payment Options (JPO).

Limitations

The only supported acquirer is Sumitomo Mitsui Card Co.

The payment must use a Visa payment card.

Prerequisites

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing a JPO Bonus Payment

Use these required fields for authorizing a JPO bonus payment.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

bill_city
bill_country
billTo_email
billTo_firstname
billTo_lastname
billTo_postalCode
billTo_state
billTo_street
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
jpo_businessNameAlpha
jpo_businessNameJapanese: Business name in kanji characters.
jpo_businessNameKanji
jpo_jccaTerminalID: Required for card-present transactions. Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.
jpo_paymentMethod: Set the value to
2
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Authorizing a JPO Bonus Payment

Request

merchantID=npr_jcn8
merchantReferenceCode=TC42703-1
jpo_businessNameAlphaNumeric=MyStore
jpo_businessNameJapanese=我社
jpo_businessNameKatakana=わが社の場合
jpo_firstPaymentMonth=02
jpo_installments=12
jpo_paymentMethod=2
billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstName=John
billTo_lastName=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street=201 S. Division St.
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2024
purchaseTotals_currency=jpy
purchaseTotals_grandTotalAmount=100.00

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=usd
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_forwardCode=Sumitomo
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Authorize an Installment Payment with Japanese Payment Options

This section shows you how to process an authorization of an installment payment with Japanese Payment Options (JPO).

Limitations

The only supported acquirer is Sumitomo Mitsui Card Co.

The payment must use a Visa payment card.

Prerequisites

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing a JPO Installment Payment

Use these required fields for authorizing a JPO installment payment.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

bill_city
bill_country
billTo_email
billTo_firstname
billTo_lastname
billTo_postalCode
billTo_state
billTo_street
ccAuthService_run: Set the value to
true
.
card_accountNumber
card_expirationMonth
card_expirationYear
jpo_businessNameAlpha
jpo_businessNameJapanese: Business name in kanji characters.
jpo_businessNameKanji
jpo_firstBillingMonth: If you do not specify this field, it is set by default to the number of the next month.
jpo_installments: Number of monthly payments.
jpo_jccaTerminalID: Required for card-present transactions. Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.
jpo_paymentMethod: Set the value to
4
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Authorizing a JPO Installment Payment

Request

merchantID=npr_jcn8
merchantReferenceCode=TC42703-1
jpo_businessNameAlphaNumeric=MyStore
jpo_businessNameJapanese=我社
jpo_businessNameKatakana=わが社の場合
jpo_firstPaymentMonth=04
jpo_installments=12
jpo_paymentMethod=4
billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstName=John
billTo_lastName=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street=201 S. Division St.
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2024
purchaseTotals_currency=jpy
purchaseTotals_grandTotalAmount=100.00

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=usd
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_forwardCode=Sumitomo
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Authorize a Revolving Payment with Japanese Payment Options

This section shows you how to process an authorization of a revolving payment with Japanese Payment Options (JPO).

Limitations

The only supported acquirer is Sumitomo Mitsui Card Co.

The payment must use a Visa payment card.

Prerequisites

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing a Revolving Payment Using the JPO Method

Use these required fields for authorizing a revolving payment using the JPO method.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

bill_city
bill_country
billTo_email
billTo_firstname
billTo_lastname
billTo_postalCode
billTo_state
billTo_street
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
jpo_businessNameAlpha
jpo_businessNameJapanese: Business name in kanji characters.
jpo_businessNameKatakana
jpo_firstPaymentMonth: Number of the month in which installment payments begin. The default value is the number of the month that follows the transaction date.
jpo_installments: Set this field to the number of installment payments.
jpo_jccaTerminalID: Required for card-present transactions. Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.
jpo_paymentMethod: Set the value to
5
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Authorizing a JPO Installment Payment

Request

merchantID=npr_jcn8
merchantReferenceCode=TC42703-1
jpo_businessNameAlphaNumeric=MyStore
jpo_businessNameJapanese=我社
jpo_businessNameKatakana=わが社の場合
jpo_firstPaymentMonth=05
jpo_installments=12
jpo_paymentMethod=5
billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstName=John
billTo_lastName=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street=201 S. Division St.
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2024
purchaseTotals_currency=jpy
purchaseTotals_grandTotalAmount=100.00

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=usd
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_forwardCode=Sumitomo
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Authorize a Combination Payment with Japanese Payment Options

This section shows you how to process an authorization of a combination bonus and installment payments with Japanese Payment Options (JPO).

Limitations

The only supported acquirer is Sumitomo Mitsui Card Co.

The payment must use a Visa payment card.

Prerequisites

You have signed a contract with your acquirer.

You have contacted your account provider for details about contracts and funding cycles. The funding cycle could differ when using JPO.

Card holders who want to use JPO have signed a contract with an issuing bank.

You have confirmed payment option availability with your account provider and card holder before implementing one of these payment options.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing a Combination Payment Using the JPO Method

Use these required fields for authorizing a combination payment using the JPO method.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

bill_city
bill_country
billTo_email
billTo_firstname
billTo_lastname
billTo_postalCode
billTo_state
billTo_street
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
jpo_businessNameAlpha
jpo_businessNameJapanese: Business name in kanji characters.
jpo_businessNameKanji
jpo_firstBillingMonth: If you do not specify this field, it is set by default to the number of the next month.
jpo_installments: Set this field to the number of monthly installments.
jpo_jccaTerminalID: Required for card-present transactions. Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.
jpo_paymentMethod: Set the value to
6
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Authorizing a JPO Combination Payment

Request

merchantID=npr_jcn8
merchantReferenceCode=TC42703-1
jpo_businessNameAlphaNumeric=MyStore
jpo_businessNameJapanese=我社
jpo_businessNameKatakana=わが社の場合
jpo_firstPaymentMonth=06
jpo_installments=12
jpo_paymentMethod=6
billTo_city=Ann Arbor
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstName=John
billTo_lastName=Smith
billTo_postalCode=48104-2201
billTo_state=MI
billTo_street=201 S. Division St.
card_accountNumber=4111111111111111
card_expirationMonth=12
card_expirationYear=2024
purchaseTotals_currency=jpy
purchaseTotals_grandTotalAmount=100.00

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=jpy
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_forwardCode=Sumitomo
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Mastercard Processing

These use cases are specific to Mastercard processing.

Mastercard Bill Payment Processing

This section describes how to request an authorization for a Mastercard Bill Payment.

Field Specific to this Use Case

Include this field with a standard authorization request when processing a Mastercard Bill Payment:

billPaymentType: Set the value to indicate the type of bill that the cardholder is paying.

Requirements

Sign up with Mastercard to participate in their bill payment program.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Related Information

See Mastercard Bill Payments for a description of and requirements for processing Mastercard Bill Payments.

Required Fields for Authorizing a Mastercard Bill Payment

Use these required fields to authorize a Mastercard bill payment.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billPaymentType: Set the value to indicate the type of bill that the cardholder is paying.
billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Authorizing a Mastercard Bill Payment

Request

ccAuthService_run=true
billTo_city=Sao Paulo
billTo_country=BR
billTo_email=john.doe@company.com
billTo_firstname=John
billTo_lastname=Smith
billTo_postalCode=04543907
billTo_state=SP
billTo_street1=Av Pres Juscelino Kubistchek 1909
card_accountNumber=555555555555xxxx
card_expirationMonth=12
card_expirationYear=2031
merchant_id=demo_merchant
merchant_referenceCode=TC42703-1
purchaseTotals_currency=BRL
purchaseTotals_grandTotalAmount=100
billPaymentType=001

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=brl
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Mastercard Expert Monitoring Solutions Processing

This section shows you how to obtain the transaction fraud score assigned by Mastercard Expert Monitoring Solutions.

Requirement

Contact customer support to enable Mastercard Expert Monitoring Solutions for your account.

After this feature is enabled for your account, Mastercard returns a fraud score for all your card-not-present authorization requests for Mastercard payment cards issued in the US.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Related Information

See Mastercard Expert Monitoring Solutions for a description of the transaction fraud score determined by Mastercard Expert Monitoring Solutions.

Required Fields for Processing an Authorization with Mastercard Expert Monitoring Solutions

Use these required fields to process an authorization using Mastercard Expert Monitoring Solutions.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Response Field for Authorizations with Mastercard Expert Monitoring Solutions

This field can be returned in a response to an authorization using Mastercard Expert Monitoring Solutions.

ccAuthReply_emsTransactionRiskScore: Fraud score for a Mastercard transaction.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Obtaining the Mastercard Fraud Score for an Authorization

Request

ccAuthService_run=true
billTo_city=Sao Paulo
billTo_country=BR
billTo_email=john.doe@company.com
billTo_firstname=John
billTo_lastname=Smith
billTo_postalCode=04543907
billTo_state=SP
billTo_street1=Av Pres Juscelino Kubistchek 1909
card_accountNumber=555555555555xxxx
card_expirationMonth=12
card_expirationYear=2031
merchant_id=demo_merchant
merchant_referenceCode=TC42703-1
purchaseTotals_currency=BRL
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
requestID=6629977932421985593067
decision=ACCEPT
reasonCode=100
merchantReferenceCode=TC42703-1
purchaseTotals_currency=brl
ccAuthService_reconciliationID=57953165A7YFPS77
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_emsTransactionRiskScore=84309
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-09-12T154953Z
ccAuthReply_paymentNetworkTransactionID=123456789619999

Payer Authentication Processing

This section shows you how to process authorizations that use these payer authentication methods:

American Express
: SafeKey

JCB
: J/Secure

Mastercard
: Identity Check

Visa
: Visa Secure

Related Information

See the Payer Authentication Developer Guide for details about payer authentication.

Providing Payer Authentication Information for Authorization

The values that are returned from payer authentication must be provided when seeking authorization for the transaction. Authentication information that is not included when considering authorization may cause the transaction to be refused or downgraded and prevent the normal liability shift from occurring.

The level of security in payer authentication is denoted by the two digit Electronic Commerce Indicator (ECI) that is assigned to the transaction. These digital values have text equivalents which are assigned to the

e_commerce_indicator

field.

The

American Express,

Diners, Discover, UPI, and Visa card brands use 05, 06, and 07 digit values to express the authentication level for a 3-D Secure transaction.

Text Values for ECI Values
ECI Value	Meaning	Visa	Diners	Discover	UPI	Amex
05	Authenticated	vbv	pb	dipb	up3ds	aesk
06	Attempted authentication with a cryptogram	vbv_attempted	pb_attempted	dipb_attempted	up3ds_attempted	aesk_attempted
07	Internet, not authenticated	vbv_failure/internet	internet	internet	up3ds_failure/internet	internet

Mastercard and Maestro cards use 00, 01, 02, 06, and 07 digit values to indicate the authentication level of the transaction.

Mastercard/Maestro Text Values for ECI Values
ECI Value	Meaning	Mastercard/Maestro
00	Internet, not authenticated	spa/internet
01	Attempted authentication	spa
02	Authenticated	spa
06	Exemption from authentication or network token without 3‑D Secure	spa
07	Authenticated merchant-initiated transaction	spa

The payer authentication response contains other information that needs to be passed on for successful authorization. Be sure to include these fields when requesting a separate authorization:

ccAuthService_directoryServerTransactionID

(Mastercard, Maestro

, UPI only

)

ccAuthService_eciRaw

ccAuthService_paresStatus

ccAuthService_paSpecificationVersion

payerAuthEnrollReply_ucafAuthenticationData

(Mastercard/Maestro only)

payerAuthValidateReply_ucafCollectionIndicator

(Mastercard/Maestro only)

ccAuthService_cavv

ccAuthService_xid

American Express SafeKey

American Express SafeKey is the authentication service in the American Express card network that uses the 3-D Secure protocol to validate customers at checkout. When you request an authorization using a supported card type and a supported processor, you can include payer authentication data in the request.

Before implementing payer authentication for American Express SafeKey, contact customer support to have your account configured for this feature.

Fields Specific to the American Express SafeKey Use Case

These API fields are required specifically for this use case.

ccAuthService_cavv: Required when payer authentication is successful.

ccAuthService_commerceIndicator: Set this field to one of these values:
aesk
: Successful authentication (3-D Secure value of
05
).
aesk_attempted
: Authentication was attempted (3-D Secure value of
06
).
internet
: Authentication failed or was not attempted (3-D Secure value of
07
).

Processor-Specific Requirements

Visa Platform Connect

transactionMode: Required only for merchants in Saudi Arabia.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Related Information

Payer Authentication Developer Guide | Simple Order API

Required Fields for Processing an Authorization Using American Express SafeKey

These fields must be included in a request for an authorization with American SafeKey. The values for these fields are in the response from the payer authentication validate service. When you request the payer authentication validate and authorization services together, the data is automatically passed from one service to the other.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
ccAuthService_cavv
ccAuthService_commerceIndicator: Set this field to one of these values:
aesk
: Successful authentication (3-D Secure value of
05
).
aesk_attempted
: Authentication was attempted (3-D Secure value of
06
).
internet
: Authentication failed or was not attempted (3-D Secure value of
07
).
ccAuthService_eciRaw: Required when the payer authentication validation service returns a raw ECI value.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount: Either
purchaseTotals_grandTotalAmount
or
item_#_unitPrice
must be included in the request.
transactionMode: Required only for merchants in Saudi Arabia.

Related Information

API field reference guide for the Simple Order API

Optional Field for Processing an Authorization Using American Express SafeKey

This field is optional in a request for an authorization with American Express SafeKey. The value for this field is in the response from the payer authentication validate service. When you request the payer authentication validate and authorization services together, the data is automatically passed from one service to the other.

ccAuthService_xid

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Authorization Using American Express SafeKey

Request

billTo_city=Sao Paulo
billTo_country=BR
billTo_email=null@cybersource.com
billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=01310-000
billTo_state=SP
billTo_street1=R. Augusta
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
ccAuthService_cavv=ABCDEFabcdefABCDEFabcdef0987654321234567
ccAuthService_commerceIndicator=aesk
merchant_id=MID23
merchant_referenceCode=Merchant_REF
purchaseTotals_currency=mxn
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

merchantReferenceCode=Merchant_REF
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=mxn
ccAuthReply_cardCategory=F
ccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_reasonCode=100
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

JCB J/Secure

JCB J/Secure is the authentication service in the JCB card network that uses the 3-D Secure protocol to validate customers at checkout. When you request an authorization using a supported card type and a supported processor, you can include payer authentication data in the request. The payer authentication services enable you to add payer authentication support to your website without running additional software on your server.

Before implementing payer authentication for JCB J/Secure, contact customer support to have your account configured for this feature.

Fields Specific to the JCB J/Secure Use Case

These API fields are required specifically for this use case.

ccAuthService_cavv: Required when payer authentication is successful.
ccAuthService_xid: Required when payer authentication is successful.
ccAuthService_eciRaw: Required when the payer authentication validation service returns a raw ECI value.

ccAuthService_commerceIndicator: Set this field to one of these values:
js
: Successful authentication for a JCB card (3-D Secure value of
05
).
js_attempted
: Authentication was attempted for a JCB card (3-D Secure value of
06
).
js_failure
: or
internet
: Authentication failed or was not attempted for a JCB card (3-D Secure value of
07
).

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Related Information

Payer Authentication Developer Guide | Simple Order API

Required Fields for Processing an Authorization Using JCB J/Secure Authentication

Use these required fields to process an authorization using JCB J/Secure authentication.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_cavv: Required when payer authentication is successful. Otherwise, this field is optional.
ccAuthService_commerceIndicator: Set this field to one of these values:
js
: Successful authentication for a JCB card (3-D Secure value of
05
).
js_attempted
: Authentication was attempted for a JCB card (3-D Secure value of
06
).
js_failure
: Authentication failed or was not attempted for a JCB card (3-D Secure value of
07
).
ccAuthService_xid
merchant_referenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Authorization Using JCB J/Secure Authentication

Request

billTo_city=Sao Paulo
billTo_country=BR
billTo_email=null@cybersource.com
billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=01310-000
billTo_state=SP
billTo_street1=R. Augusta
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2026
ccAuthService_run=true
ccAuthService_cavv=ABCDEFabcdefABCDEFabcdef0987654321234567
ccAuthService_commerceIndicator=js
ccAuthService_xid=MID23
merchant_referenceCode=Merchant_REF
purchaseTotals_currency=mxn
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

merchantReferenceCode=Merchant_REF
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=mxn
ccAuthReply_cardCategory=F
ccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_reasonCode=100
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Mastercard Identity Check

Mastercard Identity Check is the authentication service in the Mastercard card network that uses the 3-D Secure protocol in online transactions to authenticate customers at checkout.

Mastercard Identity Check generates a unique, 32-character transaction token, called the account authentication value (AAV) each time a Mastercard Identity Check-enabled account holder makes an online purchase. The AAV binds the account holder to a specific transaction. Mastercard Identity Check transactions use the universal cardholder authentication field (UCAF) as a standard to collect and pass AAV data.

Before implementing payer authentication for Mastercard Identity Check, contact customer support to have your account configured for this feature.

Fields Specific to the Mastercard Identity Check Use Case

These API fields are required specifically for this use case.

: Set this field to the transaction ID returned by Mastercard Identity Check during the authentication process.
: Set this field to the Mastercard Identity Check version returned by Mastercard Identity Check during the authentication process.
ucaf_collectionIndicator: Set to the last digit of the raw ECI value returned from authentication. For example, if ECI=02, this value should be 2.
: Set this field to one of these values:
spa
: Successful authentication (3-D Secure value of
02
).
spa
: Authentication was attempted (3-D Secure value of
01
).
spa
or
internet
: Authentication failed or was not attempted (3-D Secure value of
00
)

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing an Authorization Using Mastercard Identity Check

Use these required fields to process an authorization using Mastercard Identity Check.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
ccAuthService_cavv
ccAuthService_commerceIndicator: Set this field to one of these values:
spa
: Successful authentication (3-D Secure value of
02
).
spa
: Authentication was attempted (3-D Secure value of
01
).
spa
or
internet
: Authentication failed or was not attempted (3-D Secure value of
00
).
ccAuthService_directoryServerTransactionID
ccAuthService_paSpecificationVersion
mercahnt_id
merchant_referenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
ucaf_collectionIndicator: Set to the last digit of the raw ECI value returned from authentication. For example, if ECI=02, this value should be 2.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing an Authorization Using Mastercard Identity Check

Request

billTo_city=Sao Paulo
billTo_country=BR
billTo_email=null@cybersource.com
billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=01310-000
billTo_state=SP
billTo_street1=R. Augusta
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
ccAuthService_cavv=ABCDEFabcdefABCDEFabcdef0987654321234567
ccAuthService_commerceIndicator=spa
ccAuthService_paSpecificationVersion=1
merchant_id=MID23
merchant_referenceCode=Merchant_REF
ucaf_collectionIndicator=1
purchaseTotals_currency=mxn
purchaseTotals_grandTotalAmount=100

Response to a Successful Request

merchantReferenceCode=Merchant_REF
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=mxn
ccAuthReply_cardCategory=F
ccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_reasonCode=100
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Visa Secure

Visa Secure is the authentication service in the Visa card network that uses the 3-D Secure protocol to authenticate customers at checkout. This authentication is a two-step process. First, the cardholder is authenticated by 3-D Secure. Then, the transaction is authorized based on the 3-D Secure evaluation. This section explains how to authorize a card payment based on the 3-D Secure evaluation.

Before implementing Visa Secure, contact customer support to have your account configured for this feature.

Fields Specific to the Visa Secure Use Case

These API fields are required specifically for this use case.


ccAuthService_commerceIndicator: Set the value to
vbv
for a successful authentication (3-D Secure value of
05
),
vbv_attempted
if authentication was attempted but did not succeed (3-D Secure value of
06
), or
vbv_failure
if authentication failed (3-D Secure value of
07
).
ccAuthService_cavv: Required when payer authentication is successful.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Related Information

API field reference guide for the Simple Order API

Required Fields for Processing an Authorization Using Visa Secure

Use these required fields to process an authorization using Visa Secure.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. Refer to the Payments guide for more information about relaxed requirements in payment transactions.

Required Fields

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_cavv: This field is required when payer authentication is successful. Otherwise, this field is optional.
ccAuthService_commerceIndicator: Set the value of this field to one of these values:
vbv
: Successful authentication (EMV 3-D Secure value of
05
).
vbv_attempted
: Authentication was attempted (EMV 3-D Secure value of
06
).
vbv_failure
: or
internet
: Authentication failed or was not attempted (EMV 3-D Secure value of
07
)
ccAuthService_run: Set the value of this field to
true
.
ccAuthService_xid
merchant_referenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Validating and Authorizing an Authorization

Request

billTo_city=Sao Paulo
billTo_country=BR
billTo_email=julia@email.com
billTo_firstname=Julia
billTo_lastname=Fernandez
billTo_postalCode=01310-000
billTo_state=SP
billTo_street1=R. Augusta
card_accountNumber=41111111XXXXXXXX
card_expirationMonth=12
card_expirationYear=2023
ccAuthService_run=true
ccAuthService_cavv=ABCDEFabcdefABCDEFabcdef0987654321234567
ccAuthService_commerceIndicator=vbv
ccAuthService_xid=MID23
merchant_referenceCode=Merchant_REF
purchaseTotals_currency=mxn
purchaseTotals_grandTotalAmount=100

Response to a Successful Request


merchantReferenceCode=Merchant_REF
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=mxn
ccAuthReply_cardCategory=F
ccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_reasonCode=100
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Relaxed Requirements for Address Data and Expiration Date in Payment Transactions

With relaxed requirements for address data and the expiration date, not all standard payment request fields are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required.

Requirements

You must contact customer support in order to enable relaxed requirements for address data and expiration date.

Services

Relaxed requirements for address data and expiration date are supported for these services:

Authorization

Capture

Stand-alone credit

Subscription create

Subscription update

Relaxed Fields

When relaxed requirements for address data and expiration date are enabled for your Cybersource account, and your service request does not include one or more of the fields in the following list, you increase the risk of declined transactions and fraud depending on your location, your processor, and the cardholder's issuing bank.

It is your responsibility to determine whether a field is required for the transaction you are requesting. For example, an issuing bank can decline an authorization request for a recurring transaction with a Visa Europe card if the expiration date is incorrect, invalid, or missing. If you do not provide the correct expiration date for a recurring transaction the authorization request may be declined.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_expirationMonth: When you include this field in your request, you must also include
card_expirationYear
.; You can submit an expiration date that has expired. This exception does not apply when you combine any of the services listed above with any other service.; This field is required for payment network token transactions and subscription creation requests.
card_expirationYear: When you include this field in your request, you must also include
card_expirationMonth
.; You can submit an expiration date that has expired. This exception does not apply when you combine any of the services listed above with any other service.; This field is required for payment network token transactions and subscription creation requests.

Split Shipments Processing

Split shipments enable you to split an order into multiple shipments with multiple captures. You can use this feature when a customer orders a product that is not yet available.

Split shipments are not available for Mastercard transactions in the IDR currency on Visa Platform Connect.

Multiple partial captures
and split shipments
are not the same feature. The processor provides the multiple partial captures feature, while Cybersource provides the split shipment feature.

Requirements for Using Split Shipments

The requirements for using split shipments are you must use Visa Platform Connect and contact customer support to have your account configured for this feature.

A Visa Platform Connect account can only be enabled for either the multiple partial captures or split shipments feature, but not both.

Authorizing a Sale for a Product Not Yet Available

When the customer purchases a product that is not yet available, you can request an authorization and a sale. First request an authorization to ensure that funds are available. After the product becomes available, ship the product and request a sale. Cybersource then links the follow-on authorization to the first authorization, and then links to the capture request.

Step 1: Requesting an authorization

Request an authorization to ensure that funds are available before the product is available for immediate shipment. The authorization request requires no additional fields or requirements than a basic authorization.

Step 2: Processing a sale

When the product becomes available, ship the product and request a sale. The follow-on authorization requires you to submit a sale request that includes the

requestID

field in addition to the basic fields required for every sale request. The

requestID

field in an authorization request triggers the split-shipment functionality.

Set the field to the value from the

requestID

field from the first authorization’s response.

Field Specific to authorizing a sale for a product not yet available:

First Authorization Response Message:

requestID=SWVdPS5IM

Follow-on Authorization Request:

linkToRequest=SWVdPS5IM

Step 3: Cybersource attempts to link the follow-on authorization request to the first authorization

If the value is valid, the follow-on authorization is linked to the original authorization in the Business Center and in reports.

If the value is not valid, the follow-on authorization is not linked to the original authorization in the Business Center and in reports.

Step 4: Cybersource links the capture request

If the value for the follow-on authorization was valid, all three transactions (first authorization, follow-on authorization, capture) are linked together in the Business Center and in reports.

If the value for the follow-on 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.

Related Information

See Basic Authorizations for information on how to process a basic authorization.

See Sale for information on how to process a sale.

Processing Two Authorizations and a Capture for Multiple Products

When the customer purchases a product that is not yet available, you can request two authorizations and a capture. First request an authorization to ensure that funds are available, and then ship the available products. After the remaining products become available, request follow-on authorization to ensure funds are still available. Ship the remaining products, and request a capture. Cybersource links the follow-on authorization to the first authorization and the capture request to the other transactions.

Step 1: Requesting an authorization

Request an authorization to ensure that funds are available for one or more of the products that are available for immediate shipment. The authorization request requires no additional fields or requirements than a basic authorization.

Step 2: Requesting a follow-on authorization

After the product becomes available, request a follow-on authorization to ensure that funds are still available. The follow-on authorization request must include the

requestID

field in addition to the basic fields required for every authorization request. The

requestID

field in an authorization request triggers the split shipment functionality.

Set the field to the value from the

requestID

field from the first authorization’s response.

Field specific to requesting a follow-on authorization request:

First Authorization Response Message:

requestID=SWVdPS5IM

Follow-on Authorization Request:

linkToRequest=SWVdPS5IM

Step 3: Cybersource attempts to link the follow-on authorization request to the first authorization

If the value is valid, the follow-on authorization is linked to the original authorization in the Business Center and in reports.

If the value is not valid, the follow-on authorization is not linked to the original authorization in the Business Center and in reports.

Step 4: Requesting a capture

You ship the product and request a capture. The capture request must include the request ID in addition to the basic fields required as any capture request.

Field Specific to Processing a Capture after a Requesting a Follow-on Authorization:

Follow-on Authorization Response Message:

requestID=sl39cmdSlkJ

Capture Request:

authRequestID=sl39cmdSlkJ

Step 5: Cybersource attempts to link the capture request to the other transactions

If the

authRequestID

value for the capture is valid, all three transactions (first authorization, follow-on authorization, capture) are linked together in the Business Center and in reports.

If the

authRequestID

value for the capture is not valid, the follow-on authorization and capture are linked to each other in the Business Center and in reports, but they are not linked to the first authorization.

Related Information

See Basic Authorizations for information on how to process a basic authorization.

See Captures for information on how to process a capture.

Processing an Authorization and Two Captures for Multiple Products

When the customer orders multiple products and one is not available, you must request an authorization to ensure funds are available. You ship the products that are available and request a capture for the amount of the shipped products. When the remaining product becomes available, ship the product and request a follow-on capture for the amount of the product. Cybersource performs a system-generated authorization for the follow-on capture request. Cybersource then links the capture request. You receive the status of the follow-on capture request and its associated system-generated authorization.

Step 1: Requesting an authorization

Request an authorization to ensure that funds are available for one or more products that are available for immediate shipment. The authorization request requires no additional fields or requirements other than a basic authorization.

Step 2: Requesting a capture

Ship the available product and request a capture while you wait for the remaining product to become available. The capture request requires only the basic fields as any capture request.

Step 3: Requesting a follow-on capture

When the remaining product becomes available, ship it and request a capture for that amount. The capture request requires only the basic fields as any capture request.

Step 4: Cybersource performs a system-generated authorization

Cybersource performs a system-generated authorization for the follow-on capture request and link it to the original authorization in the Business Center and in reports. Cybersource processes the capture request as a split shipment request because your account is already enabled for split shipments.

Step 5: Cybersource attempts to link the capture request to the other transactions

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, follow-on capture) are linked together in the Business Center and in reports.

Step 6: Cybersource provides the status

The status of the follow-on capture request and its associated system-generated authorization becomes available.

Related Information

See Basic Authorizations for information on how to process a basic authorization.

See Captures for information on how to process a capture.

Processing Payments Using Credentials

This section provides the information you need in order to process payments using credentials.

Customer-Initiated Transactions with Credentials on File

A customer-initiated transaction (CIT) is a transaction initiated by the customer. There are two types of CITs:

Customer transactions during which the credentials are stored for future customer
-initiated transactions.

Customer transactions during which the credentials are stored for future merchant
-initiated transactions.

Customers can initiate a CIT at a merchant payment terminal, through an online purchase transaction, or by making a purchase using a previously stored credential. When storing cardholder data for a CIT, you must also include 3-D Secure authentication credentials to ensure that the CIT can successfully process. Authentication credentials can be stored for future use with the card credentials by doing a non-payment authentication (NPA).

`Business Center`

You can create a new customer-initiated transaction in the Business Center by going to the One-Time Payments section and requesting a new authorization. When you have entered the customer's information, you can store the customer's credentials with the customer's permission in the Payment Information section. By doing so, you can perform merchant-initiated transactions for payments that the customer has pre-approved.

For more information on how to perform a MIT in the Business Center, see Merchant-Initiated No-Show Transactions with PAN.

Storing Customer Credentials with a CIT and PAN

Before you can perform a merchant-initiated transaction (MIT) or a customer-initiated transaction (CIT) with credentials-on-file (COF), you must store the customer's credentials for later use. Further, before you can store the user's credentials, you must get the customer's consent to store their private information. This is also known as establishing a relationship with the customer.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Storing Customer Credentials During a CIT

Use these required fields for storing customer credentials during a customer-initiated transaction.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthFirst: Set the value to
true
.

Simple Order Example: Storing Customer Credentials During a CIT

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuthFirst=True

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Retrieving Stored Customer Credentials During a CIT

After customers store their credentials on file, you can retrieve these credentials to use with subsequent transactions.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Retrieving Customer Credentials During a Customer-Initiated Transaction

Use these required fields to retrieve customer credentials during a customer-initiated transaction.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthStoredCredential: Set the value to
true
.

Card-Specific Required Field for Retrieving Customer Credentials During a CIT

Discover

Discover requires the authorization amount from the original transaction in addition to the above required fields.

subsequentAuthOriginalAmount

Simple Order Example: Retrieving Customer Credentials During a CIT

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuthStoredCredential=True

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Delayed Transaction

Delayed charge transaction is performed to process a supplemental account charge after original services have been rendered and respective payment has been processed.

This section describes how to process a merchant-initiated delayed transaction, also known as a delayed charge, using these payment types:

Merchant-Initiated Delayed Transaction with PAN

Delayed charge transaction is performed to process a supplemental account charge after original services have been rendered and respective payment has been processed.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing a Merchant-Initiated Delayed Transaction

Use these required fields to process a merchant-initiated delayed transaction.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
ccAuthService_cardReferenceData: Required only for token transactions with Discover or Diners Club. Set this field to the
ccAuthReply_cardReferenceData
field that was in the response message when you obtained the customer's credentials.
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
paymentNetworkTransactionInformation: Required only for token transactions with Discover or Diners Club. Set this field to the
ccAuthReply_paymentNetworkTransactionID
field that was in the response message when you obtained the customer's credentials.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuth: Set the value to
true
.

subsequentAuthReason: Set the value to
2
.; Required only for Discover, Mastercard, and Visa.
subsequentAuthTransactionID: American Express: set to the transaction ID from the original transaction.
Discover: set to the transaction ID from the original transaction.
Visa: set to the last successful transaction ID.

Card-Specific Required Field for Processing a Merchant-Initiated Transactions

Discover

The listed card requires an additional field:

subsequentAuthOriginalAmount: Provide the original transaction amount.

Simple Order Example: Processing a Merchant-Initiated Delayed Authorization Transaction

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=install
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=true
subsequentAuthReason=2

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Incremental Transaction

An incremental authorization is used to increase the total amount authorized for a payment if the initial authorization does not cover the total cost of goods and services. An incremental transaction is an additional amount to the original authorization. The final authorized total includes amounts for both the initial and the incremental authorizations. Incremental transactions are limited to certain merchant categories, such as rental, lodging, transit, amusement parks, restaurants, and bars.

This section describes how to process an incremental transaction using these payment types:

Payment Account Number (PAN)

Merchant-Initiated Incremental Transaction with PAN

An incremental authorization is used to increase the total amount authorized for a payment if the initial authorization does not cover the total cost of goods and services. An incremental transaction is an additional amount to the original authorization. The final authorized total includes amounts for both the initial and the incremental authorizations. Incremental transactions are limited to certain merchant categories, such as rental, lodging, transit, amusement parks, restaurants, and bars.

To create an incremental transaction using the Business Center, choose one of these options:

Account Top Up

No Show

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Limitations

You can request up to 100 incremental authorizations for each transaction, in addition to the original authorization.

Interchange optimization and split shipments are not supported.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing Merchant-Initiated Incremental Transactions

Use these required fields to process merchant-initiated incremental transactions.

ccAuthService_cardReferenceData: Required only for token transactions with Discover or Diners Club. Set this field to the
ccAuthReply_cardReferenceData
field that was in the response message when you obtained the customer's credentials.
ccIncrementalAuthService_authRequestID
ccIncrementalAuthService_run: Set the value to
true
.
merchantId
merchantReferenceCode
paymentNetworkTransactionInformation: Required only for token transactions with Discover or Diners Club. Set this field to the
ccAuthReply_paymentNetworkTransactionID
field that was in the response message when you obtained the customer's credentials.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthReason: Set the value to
5
.; Required only for Discover and Visa.
subsequentAuth: Set the value to
true
.
subsequentAuthTransactionID

Simple Order Example: Processing Merchant-Initiated Incremental Transactions

Request

billTo_street1=201 S. Division St.
billTo_city=Foster City
billTo_country=US
billTo_state=CA
billTo_postalCode=94404
purchaseTotals_currency=USD
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
billTo_email=null@cybersource.com
billTo_firstName=John
billTo_lastName=Smith
purchaseTotals_grandTotalAmount=100.00
ccIncrementalAuthService_run=true
merchantID=pa_ctv_sg101
merchantReferenceCode=33557799
subsequentAuth=Y
subsequentAuthTransactionID=016153570198200
ccIncrementalAuthService_authRequestID=6541079409780593413176

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

No-Show Transactions

A no-show authorization occurs when a merchant charges a customer after the customer makes a reservation, and does not show up to claim the reservation. In this situation, the customer is charged an agreed upon fee for not showing up as expected.

This section describes how to process a merchant-initiated no-show transaction using these payment types:

Merchant-Initiated No-Show Transactions with PAN

A no-show authorization occurs when a merchant charges a customer after the customer makes a reservation, and does not show up to claim the reservation. In this situation, the customer is charged an agreed upon fee for not showing up as expected.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing Merchant-Initiated No-Show Charges

Use these required fields to process a merchant-initiated no-show charges transaction.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_cardReferenceData: Required only for token transactions with Discover or Diners Club. Set this field to the
ccAuthReply_cardReferenceData
field that was in the response message when you obtained the customer's credentials.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
paymentNetworkTransactionInformation: Required only for token transactions with Discover or Diners Club. Set this field to the
ccAuthReply_paymentNetworkTransactionID
field that was in the response message when you obtained the customer's credentials.
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthReason: Set the value to
4
.; Required only for Discover, Mastercard, and Visa.
subsequentAuth: Set the value to
true
.
subsequentAuthTransactionID: American Express: set to the transaction ID from the original transaction.
Discover: set to the transaction ID from the original transaction.
Visa: set to the last successful transaction ID.

Optional Field for Processing Merchant-Initiated No-Show Charges

You can use these optional fields to include additional information when authorizing a request for an MIT no-show charge:

subsequentAuthStoredCredential: If the payment information is COF information, Set the value to
true
.

Related Information

API field reference guide for the Simple Order API

Simple Order Example: Processing Merchant-Initiated No-Show Transactions

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=install
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=true
subsequentAuthReason=4

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Reauthorization Transaction

A reauthorization occurs when the completion or fulfillment of the original order or service extends beyond the authorized amount time limit. There are two common reauthorization scenarios:

Split or delayed shipments by a retailer

Extended car rentals, hotel stays, or cruise line bookings

This section describes how to process a reauthorization transaction using these payment methods:

Merchant-Initiated Reauthorization Transactions with PAN

A reauthorization occurs when the completion or fulfillment of the original order or service extends beyond the authorized amount time limit. There are two common reauthorization scenarios:

Split or delayed shipments by a retailer

Extended car rentals, hotel stays, or cruise line bookings

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Required Fields for Processing Merchant-Initiated Reauthorized Transactions

Use these required fields to process a merchant-initiated reauthorization transaction.

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthReason: Set the value to
3
.; Required only for Discover and Visa.
subsequentAuth: Set the value to
true
.
subsequentAuthTransactionID: American Express: set to the transaction ID from the original transaction.
Discover: set to the transaction ID from the original transaction.
Visa: set to the last successful transaction ID.

Simple Order Example: Processing a Merchant-Initiated Reauthorized Transaction

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=install
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=true
subsequentAuthReason=3

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Resubmission Transaction

A resubmission transaction is an authorization that you resubmit to recover an outstanding debt from the customer. A common scenario is when a card was initially declined due to insufficient funds, but the goods or services were already delivered to the customer.

You can request the resubmission transaction with a PAN or a TMS token.

Merchant-Initiated Resubmission Transaction with PAN

A resubmission transaction is an authorization that you resubmit to recover an outstanding debt from the customer. A common scenario is when a card was initially declined due to insufficient funds, but the goods or services were already delivered to the customer.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Processing a Merchant-Initiated Resubmitted Transaction

Use these required fields to process a merchant-initiated resubmitted transaction.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthReason: Set the value to
1
.; Required only for Discover, Mastercard, and Visa.
subsequentAuth: Set the value to
true
.
subsequentAuthTransactionID: American Express: set to the transaction ID from the original transaction.
Discover: set to the transaction ID from the original transaction.
Visa: set to the last successful transaction ID.

Simple Order Example: Processing a Merchant-Initiated Resubmitted Transaction

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=install
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=true
subsequentAuthReason=1

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Installment Payments

An installment payment is a single purchase of goods or services billed to a customer in multiple transactions over a period of time agreed to by you and the customer. The agreement enables you to charge a specific amount at specified intervals.

Installments Service for Installment Payments

Do not use this document if you are using the Installments service. When using the Installments service, Cybersource saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices.

Customer-Initiated Installment Payments with PAN

An installment payment is a single purchase of goods or services billed to a customer in multiple transactions over a period of time agreed to by you and the customer, and sometimes, the issuing bank. The agreement enables you to charge a specific amount at specified intervals. For customers, installment payments provide greater purchasing power and lower impact on their monthly budget. For you, offering installment payments at checkout can help increase the number of successfully completed purchases.

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.

In Brazil, installment payments are also known as parcelados
and parcelas
.

Do not use this document if you are using the Installments service. When using the Installments service, Cybersource saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices.

Installment Payment Types

Visa Platform Connect enables you to process installment payments but does not have a role in setting the terms for the installment plan.

Visa Platform Connect enables you to process these types of installments payments:

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—Brazil Only: 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—Brazil Only: 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.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Successful Response

You must store the network transaction ID
from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the

ccAuthReply_paymentNetworkTransactionID

field value.

Store the network transaction ID
, which is the

ccAuthReply_paymentNetworkTransactionID

field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT.

Required Fields for Initial Customer-Initiated Installment Payments with a PAN

Include these required fields to authorize an initial customer-initiated installment payment using a PAN.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: Set the value to
internet
,
MOTO
, or a payer authentication value.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthFirst: Set the value to
true
.
subsequentAuth: Set the value to
false
.

Card-Specific Fields for Authorizing Initial Installment Payments

Use this required field if you are authorizing an initial installment payment using the card type referenced below.

Mastercard: subsequentAuthReason; Set the value to
9
.

Simple Order Example: Authorizing Initial Customer-Initiated Installment Payments with a PAN

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=internet
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=false
subsequentAuthFirst=true

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Merchant-Initiated Installment Payments with PAN

After the initial CIT installment payment, subsequent installment payments are merchant-initiated transactions (MITs).

Prerequisites

The first transaction in an installment payment is a customer-initiated transaction
(CIT). Before you can perform a subsequent merchant-initiated transaction
(MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer.

Installment Payment Types

Visa Platform Connect enables you to process installment payments but does not have a role in setting the terms for the installment plan.

Visa Platform Connect enables you to process these types of installments payments:

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—Brazil Only: 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—Brazil Only: 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.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing Merchant-Initiated Subsequent Installment Payments

Use these required fields to authorize merchant-initiated subsequent installment payments.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: Set the value to
install
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuth: Set the value to
true
.
subsequentAuthStoredCredential: Set the value to
true
.
subsequentAuthTransactionID: American Express: set to the transaction ID from the original transaction.
Discover: set to the transaction ID from the original transaction.
Visa: set to the last successful transaction ID.

Country-Specific Required Fields for Installment Payments with Mastercard or Visa Card

Include these country-specific required fields for installment payments using a Mastercard or Visa card, in addition to the required fields listed above.

Argentina

Include these required fields for payments using either a Mastercard or Visa card in Argentina.

ccAuthService_commerceIndicator: Required only when the request includes payer authentication data.
installment_planType
installment_totalCount

Brazil

Include these required fields for payments using either a Mastercard or Visa card in Brazil.

billTo_companyTaxID: Not required if
billTo_personalID
is present.
billTo_personalID: Not required if
billTo_companyTaxID
is present.
billTo_phoneNumber
installment_planType
installment_totalCount
loan_type

Chile

Include these required fields for payments using either a Mastercard or Visa card in Chile.

ccAuthService_commerceIndicator
installment_planType
installment_totalCount: Optional when
installment_planType
is set to
2
.

Croatia

Include these required fields for payments using either a Mastercard or Visa card in Croatia.

billTo_merchantTaxID
installment_planType

Georgia

Include these required fields for payments using either a Mastercard or Visa card in Georgia.

installment_amount
installment_firstInstallmentAmount
installment_monthlyInterestRate
installment_planType
installment_totalCount

Greece

Include these required fields for payments using either a Mastercard or Visa card in Greece.

installment_gracePeriodDuration
installment_gracePeriodDurationType
installment_planType
installment_totalCount

Mexico

Include these required fields for payments using either a Mastercard or Visa card in Mexico with Banco Nacional de México (Banamex) or BBVA México (Bancomer).

ccAuthService_commerceIndicator: Set the value to
install_internet
.
installment_amount
installment_paymentType
installment_planType

Paraguay

Include this required field for payments using either a Mastercard or Visa card in Paraguay.

installment_planType

Peru

Include this required field for payments using either a Mastercard or Visa card in Peru.

installment_planType

India-Specific Required Fields for Installment Payments

This section shows the required fields for Diners Club, Mastercard, and Visa in India.

Diners Club and Mastercard

Use these fields for authorizing an MIT installment payment when processing payments through Visa Platform Connect.

installment_amount
installment_frequency: Required only for the first MIT installment payment.
installment_identifier
installment_paymentType
installment_sequence: Required only with Diners Club and Mastercard in India or with an India-issued card. Required only for the first MIT installment payment, not for subsequent MIT installment payments.
installment_validationIndicator

Visa

Use this field for authorizing a MIT installment payment when processing payments through Visa Platform Connect.

installment_identifier

Simple Order Example: Authorizing Merchant-Initiated Subsequent Installment Payments

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_commerceIndicator=install
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=true
subsequentAuthOriginalAmount=100.00   //This field is for Discover only.
subsequentAuthReason=9
subsequentAuthStoredCredential=true
subsequentAuthTransactionID=23976974322

Response to a Successful Response

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Recurring Payments

A recurring payment is a credentials-on-file (COF) transaction in a series of payments that you bill to a customer for a fixed amount at regular intervals that do not 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. Recurring payments are also known as subscriptions
.

Mastercard uses standing order and subscription payments instead of recurring payments. See Mastercard Standing Order Payments and Mastercard Subscription Payments.

Recurring Billing Service for Recurring Payments

Do not use this document for the Recurring Billing service.

Use the

Recurring Billing Developer Guide

. When you use the Recurring Billing service, Cybersource saves and stores payment credentials for recurring transactions, ensuring compliance with COF best practices.

Customer-Initiated Recurring Payment with PAN

A recurring payment is a credentials-on-file (COF) transaction in a series of payments that you bill to a customer at a fixed amount, at regular intervals that do not 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.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Visa

Mastercard uses standing order and subscription payments instead of recurring payments. See Mastercard Standing Order Payments and Mastercard Subscription Payments.

Recurring Billing Service for Recurring Payments

Do not use this document for the Recurring Billing service.

Use the

Recurring Billing Developer Guide

. When you use the Recurring Billing service, Cybersource saves and stores payment credentials for recurring transactions, ensuring compliance with COF best practices.

Address Verification Service for Recurring Payments

If your processor supports the Address Verification Service (AVS), then the AVS should verify every authorization request. Cybersource recommends checking the AVS's results for the first recurring payment to ensure that the payment information is accurate and to reduce the risk of fraud.

You must determine how to handle the AVS results for any subsequent recurring payments that are not the same as the already-verified billing address information from the first recurring payment.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Successful Response

You must store the network transaction ID
from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the

ccAuthReply_paymentNetworkTransactionID

field value.

Store the network transaction ID
, which is the

ccAuthReply_paymentNetworkTransactionID

field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT.

Required Fields for Authorizing a Customer-Initiated Recurring Payment with PAN

Use these required fields to request an initial customer-initiated recurring payment.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: >Set the value to
internet
, a payer authentication value, or
MOTO
.
ccAuthService_firstRecurringPayment: Set the value to
true
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthFirst: Set the value to
true
.
subsequentAuth: Set the value to
false
.

Simple Order Example: Authorizing a Customer-Initiated Recurring Payment with a PAN

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=internet
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=false
subsequentAuthFirst=true

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Mastercard Standing Order Payments

A standing order payment is a recurring COF transaction that is a variable amount at a regular interval, such as a utility bill, 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.

Mastercard Initial CIT Standing Order Payment

The first transaction in a standing order payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Successful Response

You must store the network transaction ID
from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the

ccAuthReply_paymentNetworkTransactionID

field value.

Store the network transaction ID
, which is the

ccAuthReply_paymentNetworkTransactionID

field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT.

Required Fields for Authorizing Initial CIT Standing Order Payments

Use these required fields to authorize initial customer-initated standing order payments.

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: Set the value to
internet
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthFirst: Set the value to
true
.
subsequentAuthReason: Set the value to
8
.
subsequentAuth: Set the value to
customer
.

Simple Order Example: Authorizing Initial CIT Standing Order Payments

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=internet
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuthFirst=True
subsequentAuthReason=8

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Mastercard Subscription Payments

A subscription payment is a recurring COF transaction that is processed at a fixed amount at 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.

Mastercard CIT Initial Subscription Payment

The first transaction in a subscription payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer.

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Successful Response

You must store the network transaction ID
from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the

ccAuthReply_paymentNetworkTransactionID

field value.

Store the network transaction ID
, which is the

ccAuthReply_paymentNetworkTransactionID

field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT.

Required Fields for Authorizing CIT Initial Subscription Payments

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: Set the value to
recurring
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthFirst: Set the value to
true
.
subsequentAuthReason: Set the value to
7
.
subsequentAuth: Set the value to
customer
.

Simple Order Example: Authorizing Initial CIT Subscription Payments

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=internet
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuthFirst=true
subsequentAuthReason=7

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Unscheduled COF Payments

An unscheduled credentials-on-file (COF) transaction uses stored payment information for a fixed or variable amount that does not occur regularly. An account top-up is one kind of unscheduled COF.

Customer-Initiated Unscheduled COF Payment with PAN

An unscheduled credentials-on-file (COF) transaction uses stored payment information for a fixed or variable amount that does not occur regularly. An account top-up is one kind of unscheduled COF.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Successful Response

You must store the network transaction ID
from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the

ccAuthReply_paymentNetworkTransactionID

field value.

Store the network transaction ID
, which is the

ccAuthReply_paymentNetworkTransactionID

field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT.

Required Fields for a Customer-Initiated Unscheduled COF Payment with PAN

These fields are required in a subsequent authorization request for an initial unscheduled COF payment:

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: Set the value to
internet
,
MOTO
, or a payer authentication value.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthFirst: Set the value to
true
.
subsequentAuth: Set the value to
false
.

Simple Order Example: Customer-Initiated Unscheduled COF Payment with PAN

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_run=true
ccAuthService_commerceIndicator=internet
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=false
subsequentAuthFirst=True

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Merchant-Initiated Unscheduled COF Payments with PAN

After the initial CIT unscheduled COF payment, subsequent unscheduled COF transactions are merchant-initiated transactions (MITs).

Prerequisites

The first transaction in an unscheduled COF payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer.

Supported Card Types

These are the supported card types for processing credentialed transactions:

American Express

Mastercard

Visa

Endpoint

Set the

ccAuthService_run

field to

true

.

Send the request to

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

.

Required Fields for Authorizing Subsequent MIT Unscheduled COF Payments

These fields are required in a subsequent authorization request for a subsequent unscheduled COF payment:

billTo_city
billTo_country
billTo_email
billTo_firstName
billTo_lastName
billTo_postalCode
billTo_state
billTo_street1
card_accountNumber
card_expirationMonth
card_expirationYear
ccAuthService_commerceIndicator: Set the value to
internet
.
ccAuthService_run: Set the value to
true
.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
subsequentAuthReason: Set the value to
10
.; Required only for
American Express,
Discover and Mastercard.
subsequentAuthStoredCredential: Set the value to
true
.
subsequentAuth: Set the value to
true
.
subsequentAuthTransactionID

Country-Specific Required Fields for Authorizing Subsequent Recurring Payments

Include these country-specific required fields for a successful merchant-initiated authorization.

India

These fields are required only with Diners Club in India or with an India-issued card, and you are processing payments through Visa Platform Connect.

installment_amount: Required only with Diners Club in India or with an India-issued card.
installment_frequency: Required only with Diners Club in India or with an India-issued card.
installment_identifier: Required only with Diners Club in India or with an India-issued card.
installment_paymentType: Required only with Diners Club in India or with an India-issued card.
installment_sequence: Required only with Diners Club in India or with an India-issued card.
installment_validationIndicator: Required only with Diners Club in India or with an India-issued card.

Saudi Arabia

These fields are required only if your business is located in Saudi Arabia and you are processing payments through Visa Platform Connect.

agreementID
recurringAmountType

Simple Order Example: Authorizing Subsequent MIT Unscheduled COF Payments

Request

billTo_city=Foster City
billTo_country=US
billTo_email=null@cybersource.com
billTo_firstname=John
billTo_lastname=Smith
billTo_state=CA
billTo_postalCode=94404
billTo_street1=201 S. Division St.
card_expirationMonth=12
card_expirationYear=2031
card_accountNumber=4111111111111111
ccAuthService_commerceIndicator=internet
merchantId=pa_ctv_sg101
merchantReferenceCode=33557799
purchaseTotals_currency=USD
purchaseTotals_grandTotalAmount=100.00
subsequentAuth=true
subsequentAuthOriginalAmount=100.00   //This field is for Discover only.
subsequentAuthStoredCredential=true
subsequentAuthTransactionID=23976974322

Response to a Successful Request

additional_processor_response=e1cdcafc-cdbb-4ef7-8788-a1234e844805
request_id=6461515866500167772420
decision=ACCEPT
reasonCode=100
merchantReferenceCode=Merchant_REF
purchaseTotals_currency=mxn
cardCategory=FccAuthService_reconciliationID=ZUDCXJO8KZRFXQJJ
ccAuthReply_amount=100.00
ccAuthReply_avsCode=5
ccAuthReply_authorizationCode=570110
ccAuthReply_processorResponse=1
ccAuthReply_authorizedDateTime=2022-03-01T161947Z
ccAuthReply_paymentNetworkTransactionID=111222

Payments Developer Guide

Recent Revisions to This Document

25.09.02

25.09.01

25.08.01

25.07.01

25.05.01

25.04.01

25.03

25.02

25.01

24.14

24.13

24.12

24.11

24.10

24.09

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Payments

Financial Institutions and Payment Networks

Merchant Financial Institutions (Acquirers)

Customer Financial Institutions (Issuers)

Payment Networks

Payment Processors

Visa Platform Connect Acquirers

Card Types

Co-Badged Cards

mada Co-Badged Cards

Co-Branded Cards

Credit Cards

Debit Cards

Prepaid Cards

Private Label Cards

Quasi-Cash

Transaction Types

Card-Not-Present Transactions

Card-Present Transactions

Authorizations with Card Verification Numbers

CVN Locations and Terminology

Figure:

International Transactions

Compliance

Merchant Remittance Funding

Token Management Service

Payment Services

Authorizations

Online Authorizations

Offline Authorizations

Pre-Authorizations

Payment Network Token Authorizations

Authorization Workflow

Sale

Dual-Message Processing

Partial Authorizations

Single-Message Processing

Authorization Reversals

Automatic Partial Authorization Reversals

Captures

Capture Workflow

Credits

Follow-On Credits

Stand-Alone Credits

Credit Workflow

Voids

Payment Features

Debit and Prepaid Card Payments

Requirements

Related Information

Airline Data

Supported Card Types

Supported Acquirers

Requirement

Related Information

Cybersource Airline Data Processing

Airline Data Reference Information

Airline Document Type Codes

Ancillary Service Category Codes

Interchange Optimization

Payment Cards Supported with Interchange Optimization

Automatic Authorizations

`Visa Platform Connect` Acquirers

`Token Management Service`

`Cybersource` Airline Data Processing