Cardknox is now Sola
Learn More
LogoLogo
Contact Us
  • Introduction
  • 🔗API
    • Transaction API
      • Credit Card
      • Check (ACH)
      • EBT
      • Gift Card
      • Fraud
    • Customer and Recurring API
    • Reporting API
    • Account Boarding API
      • Account Boarding Merchant Agreement
      • Account Boarding Swagger UI
    • Code Samples
    • Error Codes
  • 📦SDK
    • .NET SDK
      • Transaction Workflow
    • iOS SDK
      • iOS SDK - Technical Guide
      • Workflow
    • Android SDK
      • Android SDK - Technical Guide
  • 🧰 Cardknox Products
    • 3D Secure 2.0
      • Client-Side Integration
        • Client-Side Integration (Non-iFields)
      • Server-Side Integration
    • Account Updater
    • Batch Processing
    • Browser-Based POS systems (BBPOS)
    • CloudIM Developer Guide
    • Deep Linking
      • Deep Linking Integration for Third-Party Websites
    • EBT Online
    • Gateway Emulators
    • iFields
      • Angular iFields
    • Merchant Portal
      • FAQ
    • Mobile App
    • Split Capture
    • Tap to Phone - Android
    • Partner Portal
    • PaymentSITE
      • QR Codes for PaymentSITE
    • Webhooks
  • 📱Mobile Wallets
    • Apple Pay Hosted Checkout
      • Apple Pay Hosted Checkout Initial Setup
      • Apple Pay Prerequisites
      • Apple Pay Hosted Checkout Objects Reference (Request)
      • Apple Pay Hosted Checkout Objects Reference (Response)
      • Apple Pay iFields Integration
      • Apple Pay Hosted Checkout Sample Code
      • Apple Pay Features
      • Set up Apple Pay Merchant ID with Cardknox
    • Click-To-Pay - Hosted Checkout
      • Click-To-Pay Initial Setup
      • Click-To-Pay Sample Code
      • Click-To-Pay iFields Integration
      • Click-To-Pay Objects Reference (Request)
      • Click-To-Pay Objects Reference (Response)
    • Google Pay Hosted Checkout
      • Google Pay Control Object
      • Google Pay Request Objects
      • Google Pay Response Objects
      • Google Pay Sample Code
      • iFields Integration
      • Google Pay FAQ
  • 🔌Plugins
    • Netsuite
      • NetSuite Features and Demo
    • WooCommerce
    • Magento Plugin
    • RMH (Retail Management Hero)
    • RMS (Retail Management Systems)
  • 📖Articles
    • Frequently Asked Questions
    • How to Build POS Integration Flows
    • Card Present Integration Guide
  • Glossary of Terms
Powered by GitBook
On this page
  • Response objects
  • ApplePayload Object
  • PaymentToken Object
  • PaymentComplete Object

Was this helpful?

Export as PDF
  1. Mobile Wallets
  2. Apple Pay Hosted Checkout

Apple Pay Hosted Checkout Objects Reference (Response)

Last updated 1 year ago

Was this helpful?

Response objects

For the Full Response example click


ApplePayload Object

Name

Type

Always exists

Description

billingContact

No

Contains all transaction data. For more details please click on the link.

shippingContact

No

This is a response object that's returned by Apple after a payer approves payment.

token

PaymentToken

Yes

This is a response object that's returned by Apple after a payer approves payment.


PaymentToken Object

Name

Type

Always exists

Description

paymentData

JSON

Yes

An object containing the encrypted payment data. This is the object that needs to be Base64 Encoded and sent to gateway as xCardNum.

paymentMethod

Yes

Information about the card used in the transaction.

transactionIdentifier

String

Yes

A unique identifier for this payment

paymentData use example

var reqGateway = new
{
  .........
  xcardnum = Convert.ToBase64String(Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(req.paymentData)))
  .........
};

PaymentComplete Object

An object returned from onPaymentAuthorize ajax call - typically a Gateway Response An example of PaymentComplete Response returned by iFields is below:

{
  "xResult": "A",
  "xStatus": "Approved",
  "xError": "",
  "xErrorCode": "00000",
  "xRefNum": "481244058",
  "xExp": "0424",
  "xAuthCode": "OK8853",
  "xBatch": "6332569",
  "xAvsResultCode": "YYY",
  "xAvsResult": "Address: Match & 5 Digit Zip: Match",
  "xCvvResultCode": "S",
  "xCvvResult": "Should be On card but Not so indicated",
  "xAuthAmount": "1.12",
  "xMaskedCardNumber": "5xxxxxxxxxxx6344",
  "xCardType": "MasterCard",
  "xName": "Test Applepay",
  "xToken": "34q9h58n68qh24p7719m76m0nhm013hh",
  "xMID": "xxxxxxxxxxx0661",
  "xTID": "xxxx0003",
  "xDate": "7/13/2021 7:18:02 PM",
  "xAuthNetwork": "3",
  "xEntryMethod": "Keyed",
  "xCAVV": "ALyaPlPZZIgIADhFniB+AoABFA==",
  "xEciFlag": "01"
}

📱
here
PaymentContact
PaymentContact
PaymentMethod