Apple Pay Payment Data

May 27, 2025 ยท View on GitHub

Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.

Structure

ApplePayPaymentData

Fields

NameTypeTagsDescriptionGetterSetter
CryptogramStringOptionalOnline payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.

Constraints: Minimum Length: 1, Maximum Length: 2000, Pattern: ^.*$
String getCryptogram()setCryptogram(String cryptogram)
EciIndicatorStringOptionalECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.

Constraints: Minimum Length: 1, Maximum Length: 256, Pattern: ^.*$
String getEciIndicator()setEciIndicator(String eciIndicator)
EmvDataStringOptionalEncoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.

Constraints: Minimum Length: 1, Maximum Length: 2000, Pattern: ^.*$
String getEmvData()setEmvData(String emvData)
PinStringOptionalBank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.

Constraints: Minimum Length: 1, Maximum Length: 2000, Pattern: ^.*$
String getPin()setPin(String pin)

Example (as JSON)

{
  "cryptogram": "cryptogram6",
  "eci_indicator": "eci_indicator0",
  "emv_data": "emv_data0",
  "pin": "pin4"
}