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

# Registrar domínio

> Registra um domínio do merchant para exibir carteiras digitais na web (Apple Pay hoje; Google Pay futuramente). O domínio nasce com status pending e passa a verified quando a verificação da carteira conclui — para Apple Pay, isso exige hospedar o arquivo de associação em /.well-known/apple-developer-merchantid-domain-association. Idempotente: re-registrar um domínio existente devolve o registro atual.



## OpenAPI

````yaml POST /v1/payment-method-domains
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v1/payment-method-domains:
    post:
      tags:
        - Domínios de formas de pagamento
      summary: Registrar domínio
      description: >-
        Registra um domínio do merchant para exibir carteiras digitais na web
        (Apple Pay hoje; Google Pay futuramente). O domínio nasce com status
        pending e passa a verified quando a verificação da carteira conclui —
        para Apple Pay, isso exige hospedar o arquivo de associação em
        /.well-known/apple-developer-merchantid-domain-association. Idempotente:
        re-registrar um domínio existente devolve o registro atual.
      operationId: createPaymentMethodDomain
      parameters:
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentMethodDomainDto'
      responses:
        '200':
          description: Domínio registrado (ou já existente)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDomainResponseDto'
        '400':
          description: domainName não é um hostname válido
        '401':
          description: Credenciais inválidas ou ausentes
components:
  schemas:
    CreatePaymentMethodDomainDto:
      type: object
      properties:
        domainName:
          type: string
          maxLength: 255
          description: >-
            Domínio onde o botão da carteira (Apple Pay; Google Pay futuramente)
            será exibido, exatamente como o usuário o acessa — hostname puro,
            sem esquema, porta ou caminho. Subdomínios contam separadamente.
          example: checkout.minhaloja.com.br
      required:
        - domainName
    PaymentMethodDomainResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        domainName:
          type: string
          example: checkout.minhaloja.com.br
        status:
          type: string
          enum:
            - pending
            - verified
            - failed
          description: >-
            pending: aguardando verificação junto à carteira; verified:
            habilitado; failed: última verificação falhou (ver
            lastVerificationError)
        verifiedAt:
          type: string
          format: date-time
          nullable: true
        lastVerificationError:
          type: string
          nullable: true
          description: Último erro devolvido pela carteira ao tentar verificar o domínio
        createdAt:
          type: string
          format: date-time
        verificationFile:
          type: object
          description: >-
            Arquivo de verificação a hospedar no domínio antes do validate
            (presente na resposta do registro)
          properties:
            path:
              type: string
              example: >-
                https://checkout.minhaloja.com.br/.well-known/apple-developer-merchantid-domain-association
            content:
              type: string
              nullable: true
              description: Conteúdo do arquivo, em texto puro
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````