ApplePayPayment:
  description: |
    A representation of a payment made using Apple Pay.  
    Please note that authorizations using a payment card from the Apple Pay is set to `card holder initiated`.
  type: object
  required:
    - token
  properties:
    token:
      description: |
        The token that was returned by Apple Pay upon the consumer selecting a payment card from the Apple Wallet.  
        For Apple Pay Web it is the [ApplePayPayment](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment) instance returned in the `details` property of the [PaymentResponse](https://developer.mozilla.org/en-US/docs/Web/API/PaymentResponse) defined by the [ W3C Payment Request API](https://developer.mozilla.org/en-US/docs/Web/API/Payment_Request_API).  
        For Apple Pay App it is the [PKPayment](https://developer.apple.com/documentation/passkit/pkpayment) instance returned  as the `payment` parameter in the callback to the delegate implementation of method: [paymentAuthorizationController(_:didAuthorizePayment:handler:)](https://developer.apple.com/documentation/passkit/pkpaymentauthorizationcontrollerdelegate/2867952-paymentauthorizationcontroller).
      type: string
      format: byte
      minLength: 1
      example: eyJ0b2tlbiI6eyJwYXltZW50RGF0YSI6eyJkYXRhIjoiMndvUnVGUUlTM1dKbHdyc0ozeEEwN1NKS0FEd2JUOXdLQWQrQVdDSlRnV2EyUHJ1aW11RytIQlNDRlh5ZGNmK2tuNXJpY3RHczlEa0szd2RiOWwyWFBBTnFWTlkzWkhhcFBxY1RJZXRibGdkeDkyajVpWGFEQWNtQUU3cDY0ZnhZT1RXTEM2OEFmZmNnTVRZMTJCYk9yOUF2NDJjL3JsY3BhMnFPc1dFcGRrTjc4aUU1TzROa3RrTjJhZUhOSjBrT2RwUHpYRDBTUnZVeStLRXoyMWF4aU1jM0FpWmlrUS9jVEQwL0NuemxhUlY4V2FJK0JVMlpxTXkrYThoenA1RnZEL0Z2cWZOZkx2MVR1Q3JBNTVDMFRaaERYbkp2ZXA2THhDQmx1ejRSSWRsNWpxTWE1UGtoUUtvWEZkeWcrRFRQRjZpbEtnWEtxVDJxRkFTTHhNeURROGRFZzR2N1pmMWU4MHNRblVKOThuL1l4dFIyeisxUUsvRlZ4TDREaEtuSzdXQWdXN3VFMkFJbjNuOGw5QmpaOHZmeWVxTGgyeFVMZ3NEWGRpdUpnPT0iLCJzaWduYXR1cmUiOiJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RHpBTkJnbGdoa2dCWlFNRUFnRUZBRENBQmdrcWhraUc5dzBCQndFQUFLQ0FNSUlENHpDQ0E0aWdBd0lCQWdJSVREQkJTVkdkVkRZd0NnWUlLb1pJemowRUF3SXdlakV1TUN3R0ExVUVBd3dsUVhCd2JHVWdRWEJ3YkdsallYUnBiMjRnU1c1MFpXZHlZWFJwYjI0Z1EwRWdMU0JITXpFbU1DUUdBMVVFQ3d3ZFFYQndiR1VnUTJWeWRHbG1hV05oZEdsdmJpQkJkWFJvYjNKcGRIa3hFekFSQmdOVkJBb01Da0Z3Y0d4bElFbHVZeTR4Q3pBSkJnTlZCQVlUQWxWVE1CNFhEVEU1TURVeE9EQXhNekkxTjFvWERUSTBNRFV4TmpBeE16STFOMW93WHpFbE1DTUdBMVVFQXd3Y1pXTmpMWE50Y0MxaWNtOXJaWEl0YzJsbmJsOVZRelF0VUZKUFJERVVNQklHQTFVRUN3d0xhVTlUSUZONWMzUmxiWE14RXpBUkJnTlZCQW9NQ2tGd2NHeGxJRWx1WXk0eEN6QUpCZ05WQkFZVEFsVlRNRmt3RXdZSEtvWkl6ajBDQVFZSUtvWkl6ajBEQVFjRFFnQUV3aFYzN2V2V3g3SWhqMmpkY0pDaElZM0hzTDF2TENnOWhHQ1YyVXIwcFVFYmcwSU8yQkh6UUg2RE14OGNWTVAzNnpJZzFyclYxTy8wa29tSlBud1BFNk9DQWhFd2dnSU5NQXdHQTFVZEV3RUIvd1FDTUFBd0h3WURWUjBqQkJnd0ZvQVVJL0pKeEUrVDVPOG41c1QyS0d3L29ydjlMa3N3UlFZSUt3WUJCUVVIQVFFRU9UQTNNRFVHQ0NzR0FRVUZCekFCaGlsb2RIUndPaTh2YjJOemNDNWhjSEJzWlM1amIyMHZiMk56Y0RBMExXRndjR3hsWVdsallUTXdNakNDQVIwR0ExVWRJQVNDQVJRd2dnRVFNSUlCREFZSktvWklodmRqWkFVQk1JSCtNSUhEQmdnckJnRUZCUWNDQWpDQnRneUJzMUpsYkdsaGJtTmxJRzl1SUhSb2FYTWdZMlZ5ZEdsbWFXTmhkR1VnWW5rZ1lXNTVJSEJoY25SNUlHRnpjM1Z0WlhNZ1lXTmpaWEIwWVc1alpTQnZaaUIwYUdVZ2RHaGxiaUJoY0hCc2FXTmhZbXhsSUhOMFlXNWtZWEprSUhSbGNtMXpJR0Z1WkNCamIyNWthWFJwYjI1eklHOW1JSFZ6WlN3Z1kyVnlkR2xtYVdOaGRHVWdjRzlzYVdONUlHRnVaQ0JqWlhKMGFXWnBZMkYwYVc5dUlIQnlZV04wYVdObElITjBZWFJsYldWdWRITXVNRFlHQ0NzR0FRVUZCd0lCRmlwb2RIUndPaTh2ZDNkM0xtRndjR3hsTG1OdmJTOWpaWEowYVdacFkyRjBaV0YxZEdodmNtbDBlUzh3TkFZRFZSMGZCQzB3S3pBcG9DZWdKWVlqYUhSMGNEb3ZMMk55YkM1aGNIQnNaUzVqYjIwdllYQndiR1ZoYVdOaE15NWpjbXd3SFFZRFZSME9CQllFRkpSWDIyL1ZkSUdHaVlsMkwzNVhoUWZubTFna01BNEdBMVVkRHdFQi93UUVBd0lIZ0RBUEJna3Foa2lHOTJOa0JoMEVBZ1VBTUFvR0NDcUdTTTQ5QkFNQ0Ewa0FNRVlDSVFDK0NWY2Y1eDRlYzF0VjVhK3N0TWN2NjBSZk1CaFNJc2NsRUFLMkhyMXZWUUloQU5HTE5RcGQxdDF1c1hSZ05iRWVzczZIejZQbXIyeTlnNENKRGNnczNhcGpNSUlDN2pDQ0FuV2dBd0lCQWdJSVNXMHZ2enFZMnBjd0NnWUlLb1pJemowRUF3SXdaekViTUJrR0ExVUVBd3dTUVhCd2JHVWdVbTl2ZENCRFFTQXRJRWN6TVNZd0pBWURWUVFMREIxQmNIQnNaU0JEWlhKMGFXWnBZMkYwYVc5dUlFRjFkR2h2Y21sMGVURVRNQkVHQTFVRUNnd0tRWEJ3YkdVZ1NXNWpMakVMTUFrR0ExVUVCaE1DVlZNd0hoY05NVFF3TlRBMk1qTTBOak13V2hjTk1qa3dOVEEyTWpNME5qTXdXakI2TVM0d0xBWURWUVFERENWQmNIQnNaU0JCY0hCc2FXTmhkR2x2YmlCSmJuUmxaM0poZEdsdmJpQkRRU0F0SUVjek1TWXdKQVlEVlFRTERCMUJjSEJzWlNCRFpYSjBhV1pwWTJGMGFXOXVJRUYxZEdodmNtbDBlVEVUTUJFR0ExVUVDZ3dLUVhCd2JHVWdTVzVqTGpFTE1Ba0dBMVVFQmhNQ1ZWTXdXVEFUQmdjcWhrak9QUUlCQmdncWhrak9QUU1CQndOQ0FBVHdGeEdFR2Rka2hkVWFYaVdCQjNib2dLTHYzbnV1VGVDTi9FdVQ0VE5XMVdaYk5hNGkwSmQyRFNKT2U3b0kvWFlYem9qTGRydG1jTDdJNkNtRS8xUkZvNEgzTUlIME1FWUdDQ3NHQVFVRkJ3RUJCRG93T0RBMkJnZ3JCZ0VGQlFjd0FZWXFhSFIwY0RvdkwyOWpjM0F1WVhCd2JHVXVZMjl0TDI5amMzQXdOQzFoY0hCc1pYSnZiM1JqWVdjek1CMEdBMVVkRGdRV0JCUWo4a25FVDVQazd5Zm14UFlvYkQraXUvMHVTekFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQjhHQTFVZEl3UVlNQmFBRkx1dzNxRllNNGlhcElxWjNyNjk2Ni9heXlTck1EY0dBMVVkSHdRd01DNHdMS0Fxb0NpR0ptaDBkSEE2THk5amNtd3VZWEJ3YkdVdVkyOXRMMkZ3Y0d4bGNtOXZkR05oWnpNdVkzSnNNQTRHQTFVZER3RUIvd1FFQXdJQkJqQVFCZ29xaGtpRzkyTmtCZ0lPQkFJRkFEQUtCZ2dxaGtqT1BRUURBZ05uQURCa0FqQTZ6M0tEVVJhWnNZYjdOY05XeW1LLzlCZnQyUTkxVGFLT3Z2R2NnVjVDdDRuNG1QZWJXWitZMVVFTmo1M3B3djRDTURJdDFVUWhzS01GZDJ4ZDh6ZzdrR2Y5RjN3c0lXMldUOFp5YVlJU2IxVDRlbjBibWN1YkNZa2hZUWFaRHdtU0hRQUFNWUlCakRDQ0FZZ0NBUUV3Z1lZd2VqRXVNQ3dHQTFVRUF3d2xRWEJ3YkdVZ1FYQndiR2xqWVhScGIyNGdTVzUwWldkeVlYUnBiMjRnUTBFZ0xTQkhNekVtTUNRR0ExVUVDd3dkUVhCd2JHVWdRMlZ5ZEdsbWFXTmhkR2x2YmlCQmRYUm9iM0pwZEhreEV6QVJCZ05WQkFvTUNrRndjR3hsSUVsdVl5NHhDekFKQmdOVkJBWVRBbFZUQWdoTU1FRkpVWjFVTmpBTkJnbGdoa2dCWlFNRUFnRUZBS0NCbFRBWUJna3Foa2lHOXcwQkNRTXhDd1lKS29aSWh2Y05BUWNCTUJ3R0NTcUdTSWIzRFFFSkJURVBGdzB5TWpBNU1qRXdPRFE1TURoYU1Db0dDU3FHU0liM0RRRUpOREVkTUJzd0RRWUpZSVpJQVdVREJBSUJCUUNoQ2dZSUtvWkl6ajBFQXdJd0x3WUpLb1pJaHZjTkFRa0VNU0lFSUtoRXJrb1Qrb0h1Y0JTaVBqUVhkRzhaa3U2NS9ZdFlyTlNlakgwaDhMNEhNQW9HQ0NxR1NNNDlCQU1DQkVjd1JRSWdiaGJRcm9aaGpsY2JoSzFLSmhGVnEyNXpqdXBQMVQ2cHZ0NzVCV2czdENNQ0lRQ2QzVzFxTzNySmc2UHpjTzVhQzJ4c3pNNlQ4Q3ROL2FoMHF3YkYvNTZpVGdBQUFBQUFBQT09IiwiaGVhZGVyIjp7InB1YmxpY0tleUhhc2giOiJEdWV0UjdlcjhjUFYzdENVbUZNaHpaQ0QzRFVwdW5KUldEZTdDd0tsbm1nPSIsImVwaGVtZXJhbFB1YmxpY0tleSI6Ik1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRU5VVVBZTzNkWGY1azN2ekxoUTI5K1AzZmhGUTkrTXhWOWZ3cGk4dmZTbEVkd0FrcWI4NEZVMGFUTlNsc0lqZVplWmEyV0FqcG95M0doeEhaOFFvWWNnPT0iLCJ0cmFuc2FjdGlvbklkIjoiYzYxOWExYTQzMTg4ZjkzMWNkNzE0ZGI2NGFkNWFiZTMzNDI0ZjkyNjBhODlkZDUyOWRhNGI0MmRjNWRkZDY0OCJ9LCJ2ZXJzaW9uIjoiRUNfdjEifSwicGF5bWVudE1ldGhvZCI6eyJkaXNwbGF5TmFtZSI6IlZpc2EgMzA3MyIsIm5ldHdvcmsiOiJWaXNhIiwidHlwZSI6ImRlYml0In0sInRyYW5zYWN0aW9uSWRlbnRpZmllciI6IkM2MTlBMUE0MzE4OEY5MzFDRDcxNERCNjRBRDVBQkUzMzQyNEY5MjYwQTg5REQ1MjlEQTRCNDJEQzVEREQ2NDgifX0=
    save:
      description: |
        Boolean flag indicating whether the payment card retrieved from Apple Pay should be tokenized and saved in Transpayrent's secure vault.
        Setting this to true will set the `allowedAuthMethods` to `PAN_ONLY`.
        The saved payment card will automatically be added to Transpayrent's consumer wallet if a `consumer_id` was provided when the payment session was created.
      type: boolean
      default: false
      example: true
  allOf:
    - $ref: './payment-details_v1.yaml#/PaymentDetails'