> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnosispay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Apple Pay provisioning data

> Creates encrypted Apple Pay provisioning data for PassKit.

Call this only for an active card after Apple Pay has been enabled for the
partner. Forward the response directly to PassKit; do not log or persist
the provisioning payload.



## OpenAPI

````yaml https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cards/{card_id}/apple-pay/provisioning
openapi: 3.1.0
info:
  title: Gnosis Pay Partner API
  version: 1.0.0
  description: >-
    Server-to-server API for onboarding users, creating accounts and cards,
    moving

    funds, and managing the card lifecycle. Call this API only from a trusted

    backend. Every request requires a partner access token, and every resource
    is

    scoped to the authenticated partner.
servers:
  - url: https://core.prod.gnosispay.com/partner-api
    description: Production
    variables: {}
  - url: https://core.sandbox.gnosispay.in/core
    description: Sandbox
    variables: {}
security:
  - BearerAuth: []
tags:
  - name: Accounts
  - name: Cards
  - name: Card transactions
  - name: KYC
  - name: Deposits
  - name: Withdrawals
  - name: PCI
  - name: 3DS
  - name: Webhooks
paths:
  /v1/cards/{card_id}/apple-pay/provisioning:
    post:
      tags:
        - Cards
      summary: Create Apple Pay provisioning data
      description: >-
        Creates encrypted Apple Pay provisioning data for PassKit.


        Call this only for an active card after Apple Pay has been enabled for
        the

        partner. Forward the response directly to PassKit; do not log or persist

        the provisioning payload.
      operationId: cards.provision_apple_pay.v1
      parameters:
        - name: card_id
          in: path
          required: true
          description: The card ID.
          schema:
            $ref: '#/components/schemas/uuid'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplePayProvisioningRequest'
        description: PassKit certificate chain, nonce, and device context.
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplePayProvisioningResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    uuid:
      type: string
      format: uuid
    ApplePayProvisioningRequest:
      type: object
      required:
        - certificates
        - nonce
        - nonce_signature
        - device_type
        - app_version
      properties:
        certificates:
          type: array
          items:
            $ref: '#/components/schemas/ApplePayCertificate'
          minItems: 2
          maxItems: 2
          description: >-
            Apple-provided leaf and sub-CA certificates, in that order. The
            Apple

            Root CA G3 is downloaded separately and is not sent by the client.
        nonce:
          type: string
          minLength: 1
          description: Base64-encoded nonce supplied by PassKit.
        nonce_signature:
          type: string
          minLength: 1
          description: Base64-encoded nonce signature supplied by PassKit.
        device_type:
          $ref: '#/components/schemas/ApplePayDeviceType'
          description: Type of Apple device being provisioned.
        app_version:
          type: string
          minLength: 1
          description: Version of the partner application requesting provisioning.
        product_type:
          type: string
          minLength: 1
          description: Apple hardware product identifier, when available.
    ApplePayProvisioningResponse:
      type: object
      required:
        - activation_data
        - encrypted_pass_data
        - ephemeral_public_key
      properties:
        activation_data:
          type: string
          description: Base64-encoded activation data to pass to PassKit.
        encrypted_pass_data:
          type: string
          description: Base64-encoded encrypted pass data to pass to PassKit.
        ephemeral_public_key:
          type: string
          description: Base64-encoded ephemeral public key to pass to PassKit.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code.
        message:
          type: string
          description: Generic human-readable text for the status code. Do not parse it.
        reason:
          type: string
          description: >-
            Stable machine-readable code identifying the specific cause, present
            only

            for errors that expose one (e.g. `CREATE_CARD_LIMIT_EXCEEDED`).
            Branch on

            this rather than on `message`.
    ApplePayCertificate:
      type: string
      minLength: 1
      description: A non-empty Base64-encoded DER certificate supplied by PassKit.
    ApplePayDeviceType:
      type: string
      enum:
        - mobile_phone
        - watch
      description: Device types supported for Apple Pay push provisioning.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.