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

# Criar subconta

> Cria subconta merchant (KYC PF/PJ) e, opcionalmente, já habilita o Portal Wallet com e-mail e senha.

<RequestExample>
  ```bash cURL — PF (JSON) theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/subaccount/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{
      "personType": "PF",
      "fullName": "Maria Silva Santos",
      "cpf": "52998224725",
      "birthDate": "1990-05-15",
      "postalCode": "01310100",
      "externalReference": "titular-maria"
    }'
  ```

  ```bash cURL — PF com Portal Wallet (e-mail + senha na mesma chamada) theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/subaccount/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{
      "personType": "PF",
      "fullName": "Maria Silva Santos",
      "cpf": "52998224725",
      "birthDate": "1990-05-15",
      "postalCode": "01310100",
      "externalReference": "titular-maria",
      "portalEmail": "operador@empresa.com",
      "portalPassword": "SenhaForte!123"
    }'
  ```

  ```bash cURL — PJ (multipart) com Portal Wallet theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/subaccount/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -F 'data={"personType":"PJ","fullName":"Carlos Souza","cpf":"52998224725","birthDate":"1985-03-20","postalCode":"01310100","cnpj":"11222333000181","legalName":"Loja Parceiro LTDA","website":"https://loja.exemplo.com","externalReference":"loja-parceiro-a","portalEmail":"operador@empresa.com","portalPassword":"SenhaForte!123"};type=application/json' \
    -F 'registrationDocument=@contrato-social.pdf'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Subconta criada",
    "data": {
      "id": "clx_subconta",
      "name": "Maria Silva Santos",
      "personType": "PF",
      "cpf": "52998224725",
      "birthDate": "1990-05-15",
      "externalReference": "titular-maria",
      "status": "ACTIVE",
      "lockMode": "NONE",
      "balance": {
        "availablePadrao": 0,
        "pendingPadrao": 0,
        "lockedPadrao": 0,
        "spendablePadrao": 0
      },
      "limits": null
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Campos comuns (PF e PJ)

<ParamField body="personType" type="string" required>
  `PF` ou `PJ`.
</ParamField>

<ParamField body="fullName" type="string" required>
  Nome completo do titular (representante legal em PJ).
</ParamField>

<ParamField body="cpf" type="string" required>
  CPF válido (11 dígitos).
</ParamField>

<ParamField body="birthDate" type="string" required>
  Data de nascimento (`YYYY-MM-DD`).
</ParamField>

<ParamField body="postalCode" type="string" required>
  CEP (8 dígitos).
</ParamField>

<ParamField body="externalReference" type="string" required>
  Referência única do seu sistema (máx. 64). Obrigatória na API pública.
</ParamField>

### Portal Wallet (opcional, na mesma requisição)

Envie `portalEmail` e `portalPassword` junto com o cadastro KYC. A subconta e o login em [wallet.goatpay.com.br](https://wallet.goatpay.com.br) ficam **ativos na hora** — sem e-mail de confirmação e sem chamar `POST /subaccount/portal/setup` depois.

<ParamField body="portalEmail" type="string">
  E-mail de login do operador no Portal Wallet. Se informado, `portalPassword` é **obrigatório** na mesma requisição.
</ParamField>

<ParamField body="portalPassword" type="string">
  Senha inicial do operador (mín. 8 caracteres, maiúscula, minúscula, número e símbolo). Obrigatório junto com `portalEmail`.
</ParamField>

<Warning>
  `portalEmail` sem `portalPassword` retorna erro 400. Para subcontas já criadas sem portal, use [portal/setup](/api-reference/endpoint/subaccount/portal/setup).
</Warning>

### Campos adicionais (PJ)

<ParamField body="cnpj" type="string" required>
  CNPJ válido (14 dígitos). Obrigatório se `personType` = `PJ`.
</ParamField>

<ParamField body="legalName" type="string" required>
  Razão social. O campo `name` na resposta usa este valor.
</ParamField>

<ParamField body="website" type="string" required>
  URL do site (com ou sem `https://`).
</ParamField>

<ParamField body="registrationDocument" type="file" required>
  **Somente multipart.** Comprovante de inscrição ou contrato social (PDF, JPG, PNG ou WEBP, máx. 8 MB). Campo do formulário: `registrationDocument`. O JSON vai no campo `data`.
</ParamField>

<Note>
  * **PF:** envie `Content-Type: application/json`.
  * **PJ:** envie `multipart/form-data` com `data` (JSON) + `registrationDocument`. JSON puro para PJ retorna erro. Em PJ, `portalEmail` e `portalPassword` vão dentro do JSON do campo `data`.
  * **Portal Wallet:** mesma permissão `subaccount/create`; para gestão depois use permissões `subaccount/portal/*` ([guia](/api-reference/guides/subcontas#portal-wallet)).
  * Subcontas criadas antes do KYC permanecem válidas; os novos campos são exigidos apenas em novas criações.
  * No [dashboard](https://app.goatpay.com.br), use **Gerenciar subconta** para movimentar saldo, limites, bloqueios e pricing sem chamar a API manualmente.
</Note>


## OpenAPI

````yaml POST /subaccount/create
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /subaccount/create:
    post:
      tags:
        - subaccount
      summary: Criar subconta
      description: >
        Cria subconta merchant com cadastro KYC (PF ou PJ). `externalReference`
        obrigatório na API pública.

        Subconta **PF**: `application/json`. Subconta **PJ**:
        `multipart/form-data` com campo `data` (JSON) e `registrationDocument`
        (PDF/JPG/PNG/WEBP, máx. 8 MB).
      operationId: createSubaccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubaccount'
          multipart/form-data:
            schema:
              type: object
              required:
                - data
                - registrationDocument
              properties:
                data:
                  type: string
                  description: JSON stringificado de CreateSubaccount (personType PJ).
                registrationDocument:
                  type: string
                  format: binary
                  description: Comprovante de inscrição ou contrato social.
      responses:
        '200':
          $ref: '#/components/responses/SuccessEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    CreateSubaccount:
      type: object
      required:
        - personType
        - fullName
        - cpf
        - birthDate
        - postalCode
        - externalReference
      properties:
        personType:
          type: string
          enum:
            - PF
            - PJ
        fullName:
          type: string
          maxLength: 200
          description: Nome completo do titular (representante em PJ).
        cpf:
          type: string
          description: CPF com 11 dígitos (somente números ou formatado).
        birthDate:
          type: string
          format: date
          description: Data de nascimento (YYYY-MM-DD).
        filiation:
          type: string
          maxLength: 500
          description: Opcional. Filiação (nome dos pais ou equivalente).
        monthlyIncome:
          type: number
          minimum: 0
          description: Opcional. Renda mensal em reais.
        profession:
          type: string
          maxLength: 120
          description: Opcional. Profissão.
        postalCode:
          type: string
          description: CEP com 8 dígitos.
        cnpj:
          type: string
          description: Obrigatório se personType=PJ.
        legalName:
          type: string
          maxLength: 200
          description: Razão social (PJ).
        website:
          type: string
          maxLength: 500
          description: Site da empresa (PJ).
        externalReference:
          type: string
          maxLength: 64
        portalEmail:
          type: string
          format: email
          description: Opcional. E-mail de login no Portal Wallet (wallet.goatpay.com.br).
        portalPassword:
          type: string
          minLength: 8
          description: Obrigatório se portalEmail for informado. Senha inicial do operador.
        name:
          type: string
          deprecated: true
          description: >-
            Ignorado; use fullName (PF) ou legalName (PJ). Resposta retorna name
            derivado.
    SuccessEnvelope:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Operação concluída com sucesso
        data:
          type: object
          additionalProperties: true
        requestId:
          type: string
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  responses:
    SuccessEnvelope:
      description: Operação concluída.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
          examples:
            default:
              summary: Sucesso
              value:
                success: true
                message: Operação concluída com sucesso
                data: {}
                requestId: req_abc123
    Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Chave sem permissão para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````