On This Page
Recent Revisions to This Document
24.02
Clarified Apple Pay requirements. See Requirements for Using Apple Pay.
24.01
- Support for the mada Pay mobile app in Saudi Arabia
- ForVisa Platform Connectonly, Apple Pay supports mada Pay mobile app transactions for these payment cards, which are issued in the Kingdom of Saudi Arabia:
- mada
- Mastercard co-badged with mada
- Visa co-badged with mada
- For Apple Pay transactions on the mada Pay mobile app, specify the mada card type (060) in theAPI field.card_cardTypeSimple Order
23.04
This revision contains only editorial changes and no technical updates.
23.03
This revision contains only editorial changes and no technical updates.
23.02
This revision contains only editorial changes and no technical updates.
About This Guide
This section describes the audience and purpose of this guide and the conventions used in
this guide.
Audience and Purpose
This document is written for merchants who want to use Apple Pay in an iOS application
and use information from Apple to process payments through
Cybersource
. This
document provides an overview for integrating Apple and
Cybersource
services into an
order management system.Conventions
The following special statement is used in this document:
An
Important
statement contains information essential to
successfully completing a task or learning a concept.Customer Support
For support information about any service, visit the Support Center:
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
. 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.Visa Platform Connect
(“VPC”) processing- 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 Apple Pay
You can use the
Cybersource
platform
to process and manage Apple Pay transactions.Apple Pay is a digital payment solution that allows customers to
maake secure and convenient transactions using their Apple devices.
By adding Apple Pay to your web page, you can offer your customers
a faster and easier way to pay online,
without requiring them to enter their card details or shipping information.
Apple Pay also reduces the exposure of sensitive payment data to your system,
as the payment information is encrypted and tokenized by Apple.
Requirements for Using Apple Pay
In order to use the
Cybersource
platform to process Apple Pay
transactions, you must have these things:- ACybersourceaccount. If you do not already have aCybersourceaccount, contact your localCybersourcesales representative.
- A live merchant account with a supported processor to handle processing the transactions.
Apple Pay relies on authorizations with payment network tokens. You
can sign up for Apple Pay only when these statements are true:
- Your processor supports payment network tokens.
- Cybersourcesupports payment network tokens with your processor.
If one of these statements is not true, you must take one of these actions
before you can sign up for Apple Pay:
- Obtain a new merchant account with a processor that supports payment network tokens.
- Wait until your processor supports payment network tokens.
Supported Card Types and Optional Features
This table explains which card types and optional features are supported for each
processor.
Merchant-initiated transactions, multiple partial captures, and subsequent authorizations
are described in
Authorizations with Payment Network Tokens.
Recurring payments and split shipments are described in
Credit Card Services Optional Features.
Processor | Card Types | Optional Features |
|---|---|---|
Visa Platform Connect Supported acquirers:
|
|
|
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 | 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
Visa Platform Connect
AcquirersThe following acquirers and card types are supported for
Visa Platform Connect
: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 |
Apple Pay Integrations and Payload Decryption Methods
In response to a payment request,
Apple Pay returns an encrypted payload that contains sensitive payment information.
Two methods can be used to extract and decrypt the payment information,
and both methods support Apple Pay in-app and web transactions.
- With,CybersourcedecryptionCybersourcemanages the generation of the payment encryption key and the decryption of the Apple Pay response.This method reduces the exposure of sensitive payment data to your system.
- Withmerchant decryption, you manage both the payment encryption key generation and the decryption of the Apple Pay response.
The remainder of this section summarizes the flow of Apple Pay transaction processing for
each decryption method.
Flow of Apple Pay In-App Transactions Processed Using Cybersource Decryption
Cybersource
DecryptionThis diagram illustrates the flow of in-app transaction processing
using
Cybersource
decryption.Figure:
In-App Transaction Processing with
Cybersource
Decryption
- When the customer chooses to pay with Apple Pay, you use the Apple PassKit Framework to request the encrypted payment data from Apple.
- Apple uses the Secure Element to create apayment tokenand encrypt the token’spayment databefore it sends your application.
- The payment token is thePKPaymentTokenstructure.
- The payment data is thepaymentDatafield of thePKPaymentTokenstructure.
- You forward the encrypted payment data to your order management system.
- Using theCybersourceAPI, you submit the authorization request. In theencryptedPayment_datafield, include the Base64-encoded value that you obtained from thepaymentDatafield of thePKPaymentTokenstructure.
- Cybersourcedecrypts the payment data and forwards the information to the payment network, which includes your processor and the relevant payment card company.You must use theBusiness Centeror one of theCybersourceAPI services to capture, credit, or void the authorization.
Flow of Apple Pay In-App Transactions Processed Using Merchant Decryption
This diagram illustrates the flow of in-app transaction processing
using merchant decryption.
Figure:
In-App Transaction Processing with Merchant Decryption

- When the customer chooses to pay with Apple Pay, you use the Apple PassKit Framework to request the encrypted payment data from Apple.
- Apple uses the Secure Element to create apayment tokenand encrypt the token’spayment databefore it sends your application.
- The payment token is thePKPaymentTokenstructure.
- The payment data is thepaymentDatafield of thePKPaymentTokenstructure.
- You forward the encrypted payment data to your order management system to decrypt. For information on decryption, see the Payment Token Format Reference article in the Apple Pay Developer Documentation.
- Using theCybersourceAPI, you submit the authorization request and include the decrypted payment data.
- Cybersourceforwards the information to the payment network, which includes your processor and the relevant payment card company.You must use theBusiness Centeror one of theCybersourceAPI services to capture, credit, or void the authorization.
Flow of Apple Pay Web Transactions Using Cybersource Decryption
Cybersource
Decryption- When the customer chooses to pay with Apple Pay, you use the Apple Pay JavaScript to request the encrypted payment data from Apple.
- Apple uses the Secure Element to create apayment tokenand encrypt the token’spayment databefore it sends your application using theonpaymentauthorizedevent handler.
- The payment token is theApplePayPaymentTokenstructure.
- The payment data is thepaymentDatafield of theApplePayPaymentTokenstructure.
For more information, see Apple Pay on the Web Interactive Demo. - You forward the encrypted payment data to your order management system.
- Using theCybersourceAPI, you submit the authorization request. In theencryptedPayment_datafield, include the Base64-encoded value obtained from thepaymentDatafield of theApplePayPaymentTokenstructure.
- Cybersourcedecrypts the payment data and forwards the information to the payment network, which includes your processor and the relevant payment card company.Use theBusiness Centeror one of theCybersourceAPI services to capture, credit, or void the authorization.
Flow of Apple Pay Web Transactions Using Merchant
Decryption
- When the customer chooses to pay with Apple Pay, you use the Apple Pay JavaScript to request the encrypted payment data from Apple.
- Apple uses the Secure Element to create apayment tokenand encrypt the token’spayment databefore it sends your application using theonpaymentauthorizedevent handler.
- The payment token is theApplePayPaymentTokenstructure.
- The payment data is thepaymentDatafield of theApplePayPaymentTokenstructure.
For more information, see Apple Pay on the Web Interactive Demo. - You forward the encrypted payment data to your order management system to decrypt. For information on decryption, see the Payment Token Format Reference article in the Apple Pay Developer Documentation.
- Using theCybersourceAPI, you submit the authorization request and include the decrypted payment data.
- Cybersourceforwards the information to the payment network, which includes your processor and the relevant payment card company.Use theBusiness Centeror one of theCybersourceAPI services to capture, credit, or void the authorization.
Configuring Apple Pay Processing
A successful Apple Pay response to a payment request returns
an encrypted payload that contains sensitive payment information.
The payment information is extracted and decrypted using
Cybersource
decryption or merchant decryption.Before you can process Apple Pay transactions, you must complete these configuration
tasks:
- Generating and Loading a New Certificate Signing Request
- For processing Apple Pay transactions usingCybersourcedecryption, you must first generate an Apple Pay encryption key on the business portal and load it into the Apple development portal.
- For merchant decryption, this configuration task is not needed.
- Configuring Apple Pay Response Handling
- After the payment token is received, the transaction is finalized when you extract and decrypt the payment data.Cybersourcedecryption and merchant decryption methods consist of different configuration steps.
Generating and Loading a New Certificate Signing Request
This task is required in order to process Apple Pay transactions using
Cybersource
decryption. It does not apply to merchant decryption.Follow these steps in order to configure Apple Pay in the
Cybersource
Business Center
:- Log in to theBusiness Center:
- Production:
- On the left navigation panel, click thePayment Configurationicon.
- ClickDigital Payment Solution. The Digital Payments page appears. If you do not have the correct permissions enabled on your account, the Digital Payment Solution option does not appear on the left navigation panel.
- ClickConfigure. The Apple Pay Registration panel opens.
- Enter your Apple Merchant ID.
- ClickGenerate New CSR.
- To download your CSR, click theDownloadicon next to the key.
- Follow your browser's instructions to save and open the file.
- Complete the enrollment process by submitting your CSR to Apple.
- For information about adding certificates to your Apple Merchant ID, refer to the Apple Pay PassKit:
ADDITIONAL INFORMATION
- In-App: Setting Up Apple Pay
- Website: Configuring Your Environment
- Test your software by following the steps for processing a transaction.
ADDITIONAL INFORMATION
If you are using aCybersourcetest account, you must connect to the Apple sandbox tester account and not to the Apple production system.After you complete your testing, you must create a new CSR for theCybersourceproduction system, and you must use that CSR for the Apple production system. Until you perform these steps, you cannot enable payments in your iOS application or website. - Repeat Steps 1 through 11 with yourCybersourceproduction account and the Apple production account.
Configuring Apple Pay Response Handling
Configure one of the following decryption methods that will handle the response
payload of a successful Apple Pay transaction.
- After the payment token is received, the transaction is finalized when you extract and decrypt the payment data.
- :CybersourceDecryptionThis method forwards the encrypted payment data to your order management system. Use theCybersourceAPI to submit the authorization request, and include the Base64-encoded value obtained from thepaymentDataobject in theencryptedPayment_datafield.Example ofCybersourcedecryption:session.onpaymentauthorized = function (event) { var paymentDataString = JSON.stringify(event.payment.token.paymentData); var paymentDataBase64 = btoa(paymentDataString); }
- Merchant Decryption:This method forwards the encrypted payment data to your order management system to decrypt. Use theCybersourceAPI to submit the authorization request and include the decrypted payment data.For detailed information about decryption, see Payment Token Format Reference in the Apple Developer Center.
Processing Apple Pay Transactions
This section provides information about the different kinds of Apple Pay transactions
that you can submit:
- Authorization UsingCybersourceDecryption or Merchant Decryption
- You can request the authorization service using these decryption methods:
- Cybersourcedecryption: Within this integration,Cybersourcefacilitates all of the encryption key generation and decryption processes associated with implementing Apple Pay. This method reduces the exposure of the sensitive payment data to your system.
- Merchant decryption: Within this integration, you manage all aspects of the Apple Pay integration, from generation of the payment encryption keys to decryption of the Apple Pay payload response. As a merchant, you submit the Apple Pay payment token and other payment information toCybersourcefor processing.
- Authorization Reversal
- This service uses the request ID returned from the previous authorization. An authorization reversal releases the hold that the authorization placed on the customer’s credit card funds. Use this service to reverse an unnecessary or undesired authorization.
- Capture
- This service uses the request ID returned from the previous authorization. The request ID links the capture to the authorization. Use this service to transfer funds from the customer’s account to your bank. The transaction typically completes in two to four days.
- Sale
- A sale is a bundled authorization and capture. Request the authorization and capture services at the same time.Cybersourceprocesses the capture immediately.
Authorization Service
This section provides the information that you need for requesting the authorization
service using these methods which determine the request fields that are required to
request the authorization service. In addition, different request fields are required in
order to request the authorization service. The type of card used to process the
transaction determines which request fields are used.
After you send the request, verify the response messages to make sure that the request was
successful.
A
value of
ACCEPT
for the decision
field indicates
success. For information about response codes, see
Reason Codes for the Simple Order API
.Endpoint
Set the
ccAuthService_run
field to
true
.Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.Authorizations Using Cybersource Decryption for JCB
Cybersource
Decryption for JCBThis section provides the information you need in order to process an authorization using
Cybersource
decryption for JCB.Required Fields for Authorizing a Payment Using Cybersource Decryption for JCB
Cybersource
Decryption for JCB- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- ccAuthService_run
- Set this field totrue.
- encryptedPayment_data
- Set this field to the Base64-encoded value obtained from thepaymentDataproperty of thePKPaymentTokenobject.
- encryptedPayment_descriptor
- Set this field toRklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U.
- merchantID
- merchantReferenceCode
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- requestorID
- Set this field to your token requestor id.
- Required forVisa Platform Connect.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Optional Fields for Authorizing a Payment for Apple Pay Transactions
You can include these optional fields in a request for an authorization:
- paymentNetworkToken_assuranceMethod
- Set this field to the tokenization confidence level that is assigned by the token service provider.
Related Information
Simple Order XML Example: Cybersource Decryption and JCB
Cybersource
Decryption and JCBRequest
<requestMessage xmlns="urn:schemas-cybersource-comtransaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <encryptedPayment> <descriptor>RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U</descriptor> <data>ABCDEFabcdefABCDEFabcdef0987654321234567</data> <encoding>Base64</encoding> </encryptedPayment> <card> <cardType>001</cardType> </card> <ccAuthService run="true"/> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken> Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u </c:requestToken> <c:token> <c:expirationMonth>07</c:expirationMonth> <c:expirationYear>2025</c:expirationYear> <c:prefix>239845</c:prefix> <c:suffix>2947</c:suffix> </c:token> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Cybersource Decryption for mada
Cybersource
Decryption for madaThis section provides the information that you need in order to process an authorization
using
Cybersource
decryption for mada debit cards and mada prepaid cards
issued in the Kingdom of Saudi Arabia. Apple Pay transactions on these cards are
supported on the mada Pay mobile app and for Visa Platform Connect
only.Required Fields for Authorizing a Payment Using Cybersource Decryption for mada
Cybersource
Decryption for mada- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_cardType
- Set this field to060.
- ccAuthService_run
- Set this field totrue.
- encryptedPayment_data
- Set this field to the Base64-encoded value obtained from thepaymentDataproperty of thePKPaymentTokenobject.
- encryptedPayment_descriptor
- Set this field toRklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U.
- merchantID
- merchantReferenceCode
- paymentNetworkToken_transactionType
- Set this field to1.
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Simple Order XML Example: Cybersource Decryption for mada
Cybersource
Decryption for madaRequest
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <encryptedPayment> <descriptor>RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U</descriptor> <data>ABCDEFabcdefABCDEFabcdef0987654321234567</data> <encoding>Base64</encoding> </encryptedPayment> <card> <cardType>060</cardType> </card> <ccAuthService run="true"/> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken>Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u</c:requestToken> <c:token> <c:expirationMonth>07</c:expirationMonth> <c:expirationYear>2025</c:expirationYear> <c:prefix>239845</c:prefix> <c:suffix>2947</c:suffix> </c:token> </c:purchaseTotals> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Cybersource Decryption for Mastercard
Cybersource
Decryption for MastercardThis section provides the information you need in order to process an authorization using
Cybersource
decryption for Mastercard.Required Fields for Authorizing a Payment Using Cybersource Decryption for Mastercard
Cybersource
Decryption for Mastercard- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_cardType
- ForVisa Platform Connect, to authorize a payment on the mada Pay mobile app with a Mastercard and mada co-badged card, set this field to060.
- ccAuthService_run
- Set this field totrue.
- encryptedPayment_data
- Set this field to the Base64-encoded value obtained from thepaymentDataproperty of thePKPaymentTokenobject.
- encryptedPayment_descriptor
- Set this field toRklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U.
- merchantID
- merchantReferenceCode
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- requestorID
- Required forVisa Platform ConnectandGPX.
- Required forVisa Platform Connect.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Simple Order XML Example: Cybersource Decryption for Mastercard
Cybersource
Decryption for MastercardRequest
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <encryptedPayment> <descriptor>RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U</descriptor> <data>ABCDEFabcdefABCDEFabcdef0987654321234567</data> <encoding>Base64</encoding> </encryptedPayment> <card> <cardType>002</cardType> </card> <ccAuthService run="true"/> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken>Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u</c:requestToken> <c:token> <c:expirationMonth>07</c:expirationMonth> <c:expirationYear>2025</c:expirationYear> <c:prefix>239845</c:prefix> <c:suffix>2947</c:suffix> </c:token> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Cybersource Decryption for Visa
Cybersource
Decryption for VisaThis section provides the information you need in order to process an authorization using
Cybersource
decryption for Visa.Required Fields for Authorizing a Payment Using Cybersource Decryption for Visa
Cybersource
Decryption for Visa- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_cardType
- ForVisa Platform Connect, to authorize a payment on the mada Pay mobile app with a Visa and mada co-badged card, set this field to060.
- ccAuthService_run
- Set this field totrue.
- encryptedPayment_data
- Set this field to the Base64-encoded value obtained from thepaymentDataproperty of thePKPaymentTokenobject.
- encryptedPayment_descriptor
- Set this field toRklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U.
- merchantID
- merchantReferenceCode
- paymentNetworkToken_transactionType
- Set this field to1.
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Simple Order XML Example: Cybersource Decryption for Visa
Cybersource
Decryption for VisaRequest
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <encryptedPayment> <descriptor>RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U</descriptor> <data>ABCDEFabcdefABCDEFabcdef0987654321234567</data> <encoding>Base64</encoding> </encryptedPayment> <card> <cardType>001</cardType> </card> <ccAuthService run="true"/> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken>Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u</c:requestToken> <c:token> <c:expirationMonth>07</c:expirationMonth> <c:expirationYear>2025</c:expirationYear> <c:prefix>239845</c:prefix> <c:suffix>2947</c:suffix> </c:token> </c:purchaseTotals> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Merchant Decryption for JCB
This section provides the information you need in order to process an authorization using
merchant decryption for JCB.
Required Fields for Authorizing a Payment Using Merchant Decryption for JCB
- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_accountNumber
- Set this field to the payment network token value.
- card_expirationMonth
- Set this field to the value from the payment network token expiration month.
- card_expirationYear
- Set this field to the value from the payment network token expiration year.
- ccAuthService_cavv
- Set this field to the network token cryptogram.
- ccAuthService_commerceIndicator
- Set this field to the ECI value contained in the Apple Pay response payload.
- ccAuthService_networkTokenCryptogram
- Set this field to the network token cryptogram.
- ccAuthService_run
- Set this field totrue.
- merchantID
- merchantReferenceCode
- paymentNetworkToken_transactionType
- Set this field to1.
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Simple Order XML Example: Merchant Decryption and JCB
Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <card> <accountNumber>356611111111xxxx</accountNumber> <expirationMonth>12</expirationMonth> <expirationYear>2020</expirationYear> <cvNumber>123</cvNumber> <cardType>001</cardType> </card> <ccAuthService run="true"> <cavv>ABCDEFabcdefABCDEFabcdef0987654321234567</cavv> <eciRaw>5</eciRaw> </ccAuthService> <paymentNetworkToken> <transactionType>1</transactionType> </paymentNetworkToken> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken> Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u </c:requestToken> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</ <c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Merchant Decryption for mada
This section provides the information you need in order to process an authorization using
merchant decryption for mada debit cards and mada prepaid cards issued in the Kingdom of Saudi Arabia.
Apple Pay transactions on these cards are supported on the mada Pay mobile app and for
Visa Platform Connect
only.Required Fields for Authorizing a Payment Using Merchant Decryption for mada
- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_accountNumber
- Set this field to the payment network token value.
- card_cardType
- Set this field to060.
- card_expirationMonth
- Set this field to the value from the payment network token expiration month.
- card_expirationYear
- Set this field to the value from the payment network token expiration year.
- ccAuthService_cavv
- Set this field to the network token cryptogram.
- ccAuthService_commerceIndicator
- This value should reflect the ECI Indicator value returned in the Apple Pay response payload.
- ccAuthService_networkTokenCryptogram
- Set this field to the network token cryptogram.
- ccAuthService_run
- Set this field totrue.
- merchantID
- merchantReferenceCode
- paymentNetworkToken_transactionType
- Set this field to1.
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Simple Order XML Example: Merchant Decryption and mada
Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <card> <accountNumber>4111111111111111</accountNumber> <expirationMonth>12</expirationMonth> <expirationYear>2020</expirationYear> <cvNumber>123</cvNumber> <cardType>060</cardType> </card> <ccAuthService run="true"> <cavv>ABCDEFabcdefABCDEFabcdef0987654321234567</cavv> <commerceIndicator>internet</commerceIndicator> </ccAuthService> <paymentNetworkToken> <requestorID>987654321plokijuhygtfrdeswa</requestorID> <transactionType>1</transactionType> </paymentNetworkToken> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken>Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u</c:requestToken> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Merchant Decryption for Mastercard
This section provides the information you need in order to process an authorization using
merchant decryption for Mastercard.
Required Fields for Authorizing a Payment Using Merchant Decryption for
Mastercard
- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_accountNumber
- Set this field to the payment network token value.
- card_cardType
- ForVisa Platform Connect, to authorize a payment on the mada Pay mobile app with a Visa and mada co-badged card, set this field to060.
- card_expirationMonth
- Set this field to the value from the payment network token expiration month.
- card_expirationYear
- Set this field to the value from the payment network token expiration year.
- ccAuthService_commerceIndicator
- Set this field to the ECI value contained in the Apple Pay response payload.
- ccAuthService_networkTokenCryptogram
- Set this field to the network token cryptogram.
- ccAuthService_run
- Set this field totrue.
- merchantID
- merchantReferenceCode
- paymentNetworkToken_transactionType
- Set this field to1.
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- requestorID
- Required forVisa Platform ConnectandGPX.
- Required forVisa Platform Connect.
- transactionMode
- Required only for merchants in Saudi Arabia.
- ucaf_authenticationData
- Set this field to the network token cryptogram.
- ucaf_collectionIndicator
- Set this field to2.
Related Information
Simple Order XML Example: Merchant Decryption and Mastercard
Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <card> <accountNumber>555555555555xxxx</accountNumber> <expirationMonth>12</expirationMonth> <expirationYear>2020</expirationYear> <cvNumber>123</cvNumber> <cardType>002</cardType> </card> <ucaf> <authenticationData>ABCDEFabcdefABCDscdef0987654321234567</authenticationData> <collectionIndicator>2</collectionIndicator> </ucaf> <ccAuthService run="true"> <commerceIndicator>spa</commerceIndicator> </ccAuthService> <paymentNetworkToken> <transactionType>1</transactionType> </paymentNetworkToken> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken>Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u</c:requestToken> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorizations Using Merchant Decryption for Visa
This section provides the information you need in order to process an authorization using
merchant decryption for Visa.
Required Fields for Authorizing a Payment Using Merchant Decryption for Visa
- billTo_city
- billTo_country
- billTo_email
- billTo_firstName
- billTo_lastName
- billTo_postalCode
- billTo_state
- billTo_street1
- card_accountNumber
- Set this field to the payment network token value.
- card_cardType
- ForVisa Platform Connect, to authorize a payment on the mada Pay mobile app with a Visa and mada co-badged card, set this field to060.
- card_expirationMonth
- Set this field to the value from the payment network token expiration month.
- card_expirationYear
- Set this field to the value from the payment network token expiration year.
- ccAuthService_cavv
- Set this field to the network token cryptogram.
- ccAuthService_commerceIndicator
- Set this field to the ECI value contained in the Apple Pay response payload.
- ccAuthService_networkTokenCryptogram
- Set this field to the network token cryptogram.
- ccAuthService_run
- Set this field totrue.
- merchantID
- merchantReferenceCode
- paymentNetworkToken_transactionType
- Set this field to1.
- paymentSolution
- Set this field to001.
- purchaseTotals_currency
- purchaseTotals_grandTotalAmount
- EitherpurchaseTotals_grandTotalAmountoritem_#_unitPricemust be included in the request.
- requestorID
- Required only forVisa Platform Connect.
- transactionMode
- Required only for merchants in Saudi Arabia.
Related Information
Simple Order XML Example: Merchant Decryption and Visa
Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.121"> <merchantID>demomerchant</merchantID> <merchantReferenceCode>demorefnum</merchantReferenceCode> <billTo> <firstName>Jane</firstName> <lastName>Smith</lastName> <street1>123 Main Street</street1> <city>Small Town</city> <state>CA</state> <postalCode>98765</postalCode> <country>US</country> <email>jsmith@example.com</email> </billTo> <purchaseTotals> <currency>USD</currency> <grandTotalAmount>5.00</grandTotalAmount> </purchaseTotals> <card> <accountNumber>4111111111111111</accountNumber> <expirationMonth>12</expirationMonth> <expirationYear>2020</expirationYear> <cvNumber>123</cvNumber> <cardType>001</cardType> </card> <ccAuthService run="true"> <cavv>ABCDEFabcdefABCDEFabcdef0987654321234567</cavv> <commerceIndicator>internet</commerceIndicator> </ccAuthService> <paymentNetworkToken> <transactionType>1</transactionType> </paymentNetworkToken> <paymentSolution>001</paymentSolution> </requestMessage>
Response to a Successful Request
<c:replyMessage> <c:merchantReferenceCode>demorefnum</c:merchantReferenceCode> <c:requestID>4465840340765000001541</c:requestID> <c:decision>ACCEPT</c:decision> <c:reasonCode>100</c:reasonCode> <c:requestToken>Ahj/7wSR5C/4Icd2fdAKakGLadfg5535r/ghx3Z90AoBj3u</c:requestToken> <c:purchaseTotals> <c:currency>USD</c:currency> </c:purchaseTotals> <c:ccAuthReply> <c:reasonCode>100</c:reasonCode> <c:amount>5.00</c:amount> <c:authorizationCode>888888</c:authorizationCode> <c:avsCode>X</c:avsCode> <c:avsCodeRaw>I1</c:avsCodeRaw> <c:authorizedDateTime>2015-11-03T20:53:54Z</c:authorizedDateTime> <c:processorResponse>100</c:processorResponse> <c:reconciliationID>11267051CGJSMQDC</c:reconciliationID> </c:ccAuthReply> </c:replyMessage>
Authorization Reversals
This section provides the information you need in order 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.
Supported Card Types
All supported card types can process reversals. For a list of all supported card types, see
Payment Processors.
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
- card_cardType
- ForVisa Platform Connect, when reversing the authorization of an Apple Pay transaction on the mada Pay mobile app, set this field to060. Apple Pay transactions on the mada Pay app are supported for these cards issued in the Kingdom of Saudi Arabia:
- mada debit and prepaid cards
- Mastercard payment cards co-badged with mada
- Visa payment cards co-badged with mada
- ccAuthReversalService_authRequestID
- Set this field to the request ID that was included in the authorization response message.
- ccAuthReversalService_run
- Set this field totrue.
- merchantReferenceCode
- merchantTransactionIdentifier
- 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 merchantTransactionIdentifier=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
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. For a list of all supported card types, see
Payment Processors.
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
- card_cardType
- ForVisa Platform Connect, when capturing the authorization of an Apple Pay transaction on the mada Pay mobile app, set this field to060. Apple Pay transactions on the mada Pay app are supported for these cards issued in the Kingdom of Saudi Arabia:
- mada debit and prepaid cards
- Mastercard payment cards co-badged with mada
- Visa payment cards co-badged with mada
- ccCaptureService_authRequestID
- ccCaptureService_run
- merchantID
- merchantReferenceCode
- Set tomerchant_ref_numbervalue 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
Searching for Apple Pay Transactions
Use the Transaction Search page in the
Business Center
to identify Apple Pay
transactions. You can search for transactions by date, application type, customer name,
and other transaction identifiers. For information about the Transaction Request Report, see the
Business Center
Reporting Developer
Guide
.