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

# Get settings

> Return the operating `mode` of this instance, along with the settings uploaded via [Update settings](/products/guardian/api-reference/wallet/update-settings). All fields other than `mode` are `null` until the first upload, and always `null` on `sf_operated` instances, where the Apple identity is mounted by Starfish and not exposed through this endpoint.




## OpenAPI

````yaml /products/guardian/openapi.yaml get /api/wallet/apple-pay/settings
openapi: 3.1.0
info:
  title: Guardian API
  version: '1.0'
  contact:
    name: Starfish GmbH & Co. KG
    email: hello@starfish.team
    url: https://hellgate.io/cpa/guardian
  license:
    name: Hellgate API Terms
    url: https://hellgate.io/terms-and-conditions
servers:
  - url: https://{cluster_id}.on-hellgate.cloud
    description: Guardian service instance
    variables:
      cluster_id:
        default: my-cluster-id
        description: |
          Guardian is a service of the Hellgate Cloud Platform.
          The unique cluster-id is used to connect to your instance.
security: []
tags:
  - name: pci
    description: Management of card payment credentials under the ruling of PCI DSS.
  - name: network
    description: Management of network tokens and cryptograms for secure transactions.
  - name: generic
    description: Management of generic tokens and their schemas for various use cases.
  - name: metadata
    description: Inquiries for card metadata based on PAN, PCI tokens, or network tokens.
  - name: wallet
    description: >-
      Management of wallet tokens ingested from device wallets such as Google
      Pay.
  - name: apikey
    description: Management of API keys for service access.
  - name: webhook
    description: Management of webhooks for event notifications.
  - name: types
    description: Management of types for generic token schemas.
paths:
  /api/wallet/apple-pay/settings:
    get:
      tags:
        - wallet
      summary: Get settings
      description: >
        Return the operating `mode` of this instance, along with the settings
        uploaded via [Update
        settings](/products/guardian/api-reference/wallet/update-settings). All
        fields other than `mode` are `null` until the first upload, and always
        `null` on `sf_operated` instances, where the Apple identity is mounted
        by Starfish and not exposed through this endpoint.
      operationId: wallet_apple_pay_settings_get
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apple_pay_settings'
        '401':
          $ref: '#/components/responses/401_UnauthorizedError'
        '403':
          $ref: '#/components/responses/403_ForbiddenError'
      security:
        - APIKey: []
        - AdminToken: []
components:
  schemas:
    apple_pay_settings:
      title: Apple Pay Settings
      type: object
      properties:
        mode:
          type: string
          description: >
            The operating mode of this instance. `self_managed` means you upload
            and manage your own Apple identity and certificates; `sf_operated`
            means Starfish operates the Apple Developer relationship and mounts
            the identity and certificates.
          enum:
            - self_managed
            - sf_operated
        merchant_identifier:
          type: string
          nullable: true
          example: merchant.com.example
        display_name:
          type: string
          nullable: true
          example: Example Store
        domain_association_content:
          type: string
          nullable: true
          description: >-
            The body of the domain-association file served at
            `/.well-known/apple-developer-merchantid-domain-association.txt`.
        csr_common_name:
          type: string
          nullable: true
          example: Example Store
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
      required:
        - mode
    ErrorGeneric:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorStatusCode'
        classifier:
          $ref: '#/components/schemas/ErrorClassifier'
        message:
          $ref: '#/components/schemas/ErrorMessage'
    ErrorStatusCode:
      type: integer
      description: The corresponding HTTP status code for the error
    ErrorClassifier:
      type: string
      description: Technical code that helps to identify the error
    ErrorMessage:
      type: string
      description: Human readable representation of the error
  responses:
    401_UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
          example:
            code: 401
            message: No valid means of authentication was provided
            classifier: UNAUTHORIZED
    403_ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
          example:
            code: 403
            message: Not allowed to access this resource or feature
            classifier: FORBIDDEN
  securitySchemes:
    APIKey:
      type: apiKey
      name: x-api-key
      in: header
    AdminToken:
      type: apiKey
      name: x-admin-token
      in: header

````