On This Page
Authorizing Apple Pay Digital Wallet Payments (with Elavon)
Elavon
)Elavon
supports Apple Pay digital wallet transactions.
An Apple Pay digital wallet uses tokenization
to prevent sensitive card data from
being exposed or intercepted during transactions. A token is generated when a user adds
a supported card to their Apple Pay digital wallet.Elavon
supports 3-D Secure 2.2 with Diners Club, Mastercard, and Visa card transactions.IMPORTANT
Elavon
does not support the 3-D Secure 2.2 protocol if it
is used with network tokens
or digital payment
. Barclays
will decline any transaction processed by Elavon
that uses both 3-D Secure 2.2 and either network tokens or
digital payments.This section shows you how to request authorization of a Apple Pay digital wallet payment:
Authorizing an Apple Pay Digital Wallet Payment without 3-D Secure
The topics in this section show to how to authorize an Apple Pay digital wallet payment
without 3-D Secure authentication:
- Basic steps
- Required fields
- Mastercard example
- Common error responses and resolutions
When 3-D Secure is not used, the transaction ID is automatically populated with the cryptogram value
For general information about basic authorizations, see the
"Standard Payments Processing" section of the .
Basic Steps to Authorize an Apple Pay Digital Wallet Payment without 3-D Secure
- Follow these steps to request an Apple Pay payment on a supported card without 3-D Secure authentication:
- Create the request message with the requiredRESTAPI fields.
- Use the API fields listed in Required Fields to Authorize an Apple Pay Digital Wallet Payment without 3-D Secure.These REST API fields are specific to this request payload:
- merchantInformation.merchantDomain
- paymentInformation.tokenizedCard.cryptogram
- paymentInformation.tokenizedCard.transactionType
- processingInformation.commerceIndicator
- processingInformation.paymentSolution
- Refer to the example Diners Club Example: Authorize an Apple Pay Digital Wallet Payment without 3-D Secure.IMPORTANTThe example is based on a Diners Club transaction. For a Mastercard or a Visa card transaction, set the card-specific value for thepaymentInformation.tokenizedCard.typefield.
- Send the message to one of these endpoints:
- Production:POSThttps://api.smartpayfuse.barclaycard/pts/v2/payments
- Test:POSThttps://api.smartpayfuse-test.barclaycard/pts/v2/payments
- Verify the response messages to make sure that the request was successful.
ADDITIONAL INFORMATION
A 200-level HTTP response code indicates success. See the . - If the response message contain errors, see Common Error Responses for Transactions without 3-D Secure.
Required Fields to Authorize an Apple Pay Digital Wallet Payment without 3-D
Secure
These REST API fields are required to request authorization of an Apple Pay Digital
Wallet payment without 3-D Secure authentication.
- clientReferenceInformation.code
- merchantInformation.merchantId
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.totalAmount
- orderInformation.billTo.address1
- orderInformation.billTo.administrativeArea
- orderInformation.billTo.country
- orderInformation.billTo.email
- orderInformation.billTo.firstName
- orderInformation.billTo.lastName
- orderInformation.billTo.locality
- orderInformation.billTo.phoneNumber
- orderInformation.billTo.postalCode
- paymentInformation.tokenizedCard.cryptogram
- Set the value to the network token cryptogram from Apple Pay.
- paymentInformation.tokenizedCard.expirationMonth
- paymentInformation.tokenizedCard.expirationYear
- paymentInformation.tokenizedCard.transactionType
- Set the value to1for network tokens.
- paymentInformation.tokenizedCard.type
- Set the value to the card type code. Possible values:
- 001for Visa
- 002for Mastercard
- 005for Diners Club
- processingInformation.commerceIndicator
- Set the value tointernetfor a Diners Club, Discover, and Visa card for an authorization request without 3-D Secure authentication.
- processingInformation.paymentSolution
- Set the value to001for Apple Pay in-app and web transactions.
Diners Club Example: Authorize an Apple Pay Digital Wallet Payment without 3-D Secure
Request
{ "clientReferenceInformation": { "code": "DINERS-NO3DS-APPLEPAY-002" }, "orderInformation": { "amountDetails": { "totalAmount": "89.99", "currency": "USD" }, "billTo": { "firstName": "Maria", "lastName": "Garcia", "address1": "123 Main Street", "locality": "San Francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "[email protected]", "phoneNumber": "415-555-0123" } }, "paymentInformation": { "tokenizedCard": { "cryptogram": "BgAAAAAABk4DWZ4C28yUQAAAAAA=", "transactionType": "1", "expirationMonth": "11", "expirationYear": "2026", "type": "005" } }, "processingInformation": { "paymentSolution": "001", "commerceIndicator": "internet" }, "merchantInformation": { "merchantId": "demo_merchant_12345" } }
Common Error Responses for Transactions without 3-D Secure
This topic lists common error responses to transaction requests without 3-D Secure authentication.
- 3DS ECI provided for non-3DS transaction
- Cause: Invalid e-commerce indicator for a transaction that does not use 3-D Secure.
- Resolution: Make sure theprocessingInformation.commerceIndicatorfield is set tointernetto indicate a transaction without 3-D Secure authentication. You could also omit the field from your request and let the gateway assign the value.
- Authentication data present in non-3DS transaction
- Cause: Conflicting authentication data.
- Resolution: Remove the cardholder authentication data, which is used for transactions with 3-D Secure:
- Remove theconsumerAuthenticationInformation. cavvfield (for Diners Club or Visa cards).
- Remove theconsumerAuthenticationInformation. ucafAuthenticationDatafield (for Mastercard only).
- Digital wallet transaction missing required cryptogram
- Cause: Missing or invalid cryptogram.
- Resolution: Make sure thepaymentInformation.tokenizedCard.cryptogramfield is populated with the correct value.
Authorizing an Apple Pay Digital Wallet Payment with 3-D Secure
The topics in this section show to how to authorize an Apple Pay digital wallet payment
with 3-D Secure authentication:
- Basic steps
- Required fields
- Diners Club example
For general information about basic authorizations, see the
"Standard Payments Processing" section of the .
Basic Steps to Authorize an Apple Pay Digital Wallet Payments with 3-D Secure
- Follow these steps to authorize an Apple Pay payment on Mastercard with 3-D Secure authentication:
- Create the request message with the requiredRESTAPI fields.
- Use the API fields listed in Required Fields to Authorize an Apple Pay Digital Wallet Payment with 3-D Secure.These REST API fields are specific to this payload:
- merchantInformation.merchantDomain
- consumerAuthenticationInformation.cavv—Diners Club and Visa only
- consumerAuthenticationInformation.ucafAuthenticationData—Mastercard only
- consumerAuthenticationInformation.ucafCollectionIndicator—Mastercard only
- paymentInformation.tokenizedCard.cryptogram
- paymentInformation.tokenizedCard.transactionType
- paymentInformation.tokenizedCard.type
- processingInformation.commerceIndicator
- processingInformation.paymentSolution
- processingInformation.paymentNetworkTokenTransactionType
- Refer to the example Visa Card Example: Authorize an Apple Pay Digital Wallet Payment with 3-D Secure.IMPORTANTThe example is based on a Visa card transaction. Set these fields to the appropriate values based on the card type:
- paymentInformation.tokenizedCard.type
- processingInformation.commerceIndicator
- Send the message to one of these endpoints:
- Production:POSThttps://api.smartpayfuse.barclaycard/pts/v2/payments
- Test:POSThttps://api.smartpayfuse-test.barclaycard/pts/v2/payments
- Verify the response messages to make sure that the request was successful.
ADDITIONAL INFORMATION
A 200-level HTTP response code indicates success. See the .
Required Fields to Authorize an Apple Pay Digital Wallet Payment with 3-D Secure
These REST API fields are required to request authorization of an Apple Pay digital wallet payment
with 3-D Secure authentication.
- clientReferenceInformation.code
- consumerAuthenticationInformation.cavv
- For Diners Club and Visa cards only—Set this value to the universal cardholder authentication number to indicate 3-D Secure authentication.
- consumerAuthenticationInformation.directoryServerTransactionId
- consumerAuthenticationInformation.paSpecificationVersion
- consumerAuthenticationInformation.ucafAuthenticationData
- For Mastercard transactions only—Set this value to the universal cardholder authentication field (UCAF) data to indicate 3-D Secure authentication.
- consumerAuthenticationInformation.ucafCollectionIndicator
- For Mastercard transactions only—Set this field to one of these values:
- 2: UCAF collection is supported on your website and the UCAF was populated. This value indicates a successful Mastercard Identity Check transaction.6: UCAF collection is supported on your website and the UCAF was populated based on the risk assessment that you performed. This value is supported only for Masterpass transactions.
- merchantInformation.merchantId
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.totalAmount
- orderInformation.billTo.address1
- orderInformation.billTo.country
- orderInformation.billTo.email
- orderInformation.billTo.firstName
- orderInformation.billTo.lastName
- orderInformation.billTo.locality
- orderInformation.billTo.phoneNumber
- orderInformation.billTo.postalCode
- paymentInformation.tokenizedCard.cryptogram
- Set the value to the network token cryptogram from Apple Pay.
- paymentInformation.tokenizedCard.expirationMonth
- paymentInformation.tokenizedCard.expirationYear
- paymentInformation.tokenizedCard.transactionType
- Set the value to1.
- paymentInformation.tokenizedCard.type
- Set the value to the card type code. Possible values:
- 001for Visa
- 002for Mastercard
- 005for Diners Club
- processingInformation.commerceIndicator
- Set the value to the code for the 3-D Secure authentication service. Possible values:
- pbfor 3-D Secure authentication by Diners Club ProtectBuy
- spafor 3-D Secure authentication by Mastercard Identity Check
- vbvfor 3-D Secure authentication by Visa Secure
- processingInformation.paymentSolution
- Set the value to001for Apple Pay in-app and web transactions.
Visa Card Example: Authorize an Apple Pay Digital Wallet
Payment with 3-D Secure
Request
{ "clientReferenceInformation": { "code": "VISA-3DS-APPLEPAY-006" }, "orderInformation": { "amountDetails": { "totalAmount": "199.00", "currency": "EUR" }, "billTo": { "firstName": "Pierre", "lastName": "Dubois", "address1": "15 Rue de la Paix", "locality": "Paris", "postalCode": "75001", "country": "FR", "email": "[email protected]", "phoneNumber": "+33-1-42-96-12-34" } }, "paymentInformation": { "tokenizedCard": { "cryptogram": "BwABBJQ0AgAAAAAgJDUCAAAAAAA=", "transactionType": "1", "expirationMonth": "08", "expirationYear": "2027", "type": "001" } }, "consumerAuthenticationInformation": { "cavv": "BgABBJQ0AgAAAAAgJDUCAAAAAA=", "directoryServerTransactionId": "8a2+89r+vs8fsc8w+v+79y==", "paSpecificationVersion": "2.2.0" }, "processingInformation": { "paymentSolution": "001", "commerceIndicator": "vbv" }, "merchantInformation": { "merchantId": "demo_merchant_12345" } }