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

# Configurar checkout de cartao

Retorna a configuracao publica do checkout de cartao atualmente habilitado para a sua conta.

<Info>
  Use este endpoint antes de abrir um checkout self-hosted para descobrir `publishableKey`, modos suportados e readiness do ambiente.
</Info>


## OpenAPI

````yaml GET /v1/integrations/card/config
openapi: 3.0.3
info:
  title: AXNPAY Integrations API
  version: '2026-05-02'
  description: >-
    Referencia publica para integracao de cobrancas, saques, conciliacao e
    checkout de cartao da AXNPAY.
servers:
  - url: https://api.axnpay.com.br
security:
  - secretKeyAuth: []
paths:
  /v1/integrations/card/config:
    get:
      tags:
        - Integrations
      summary: Consultar configuracao publica do checkout de cartao
      responses:
        '200':
          description: Configuracao publica do checkout de cartao para o frontend
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardConfigResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CardConfigResponse:
      type: object
      properties:
        checkout:
          $ref: '#/components/schemas/CardCheckoutConfig'
      required:
        - checkout
    CardCheckoutConfig:
      type: object
      properties:
        enabled:
          type: boolean
        publishableKey:
          type: string
          nullable: true
        supportedUiModes:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutUiMode'
        defaultUiMode:
          type: string
          enum:
            - hosted
            - embedded
            - custom
          nullable: true
        defaultSuccessUrl:
          type: string
          nullable: true
        defaultCancelUrl:
          type: string
          nullable: true
        defaultReturnUrl:
          type: string
          nullable: true
        paymentMethodConfigurationId:
          type: string
          nullable: true
        accountDisplayName:
          type: string
          nullable: true
        livemode:
          type: boolean
        isWebhookConfigured:
          type: boolean
        webhookEndpointUrl:
          type: string
          nullable: true
        isReadyForHostedCheckout:
          type: boolean
        isReadyForSelfHostedCheckout:
          type: boolean
        walletNotes:
          type: object
          properties:
            applePay:
              type: string
            googlePay:
              type: string
            link:
              type: string
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
        error:
          type: string
        message:
          type: string
        detail:
          type: object
          additionalProperties: true
      required:
        - statusCode
        - error
        - message
    CheckoutUiMode:
      type: string
      enum:
        - hosted
        - embedded
        - custom
  responses:
    Unauthorized:
      description: Nao autenticado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    secretKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_live_prod_*
      description: 'Use sua secret key: Bearer sk_live_prod_...'

````