Vault Apple Pay Request

November 13, 2025 ยท View on GitHub

A resource representing a request to vault Apple Pay.

Structure

VaultApplePayRequest

Fields

NameTypeTagsDescriptionGetterSetter
TokenStringOptionalEncrypted Apple Pay token, containing card information. This token would be base64 encoded.

Constraints: Minimum Length: 1, Maximum Length: 10000, Pattern: ^.*$
String getToken()setToken(String token)
CardApplePayRequestCardOptionalThe payment card to be used to fund a payment. Can be a credit or debit card.ApplePayRequestCard getCard()setCard(ApplePayRequestCard card)

Example (as JSON)

{
  "token": "token4",
  "card": {
    "type": "UNKNOWN",
    "brand": "CB_NATIONALE",
    "billing_address": {
      "address_line_1": "address_line_12",
      "address_line_2": "address_line_28",
      "admin_area_2": "admin_area_28",
      "admin_area_1": "admin_area_14",
      "postal_code": "postal_code0",
      "country_code": "country_code8"
    }
  }
}