> ## 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.

# Definir taxas da subconta

> Acréscimo de taxa PIX entrada/saída somado à taxa da conta principal.

Subcontas operam **somente no trilho Padrão**. A taxa cobrada na subconta é:

**taxa da conta principal + acréscimo configurado** (percentual e/ou fixo).

Taxas globais da conta principal são definidas no painel da conta. Esta rota da API pública configura apenas o **acréscimo** por subconta.

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/subaccount/set-pricing' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{
      "id": "clx_subconta",
      "lines": [
        {
          "operation": "PIX_PADRAO_DEPOSIT",
          "extraPercentFee": 1.5,
          "extraFixedFee": 0.50,
          "useGlobal": false
        },
        {
          "operation": "PIX_PADRAO_TRANSFER",
          "extraFixedFee": 1.00,
          "useGlobal": false
        }
      ]
    }'
  ```
</RequestExample>

<ParamField body="id" type="string" required>
  ID da subconta.
</ParamField>

<ParamField body="lines" type="array" required>
  Regras de acréscimo. Apenas `PIX_PADRAO_DEPOSIT` (PIX entrada) e `PIX_PADRAO_TRANSFER` (PIX saída).
</ParamField>

| Campo             | Descrição                                                            |
| ----------------- | -------------------------------------------------------------------- |
| `operation`       | `PIX_PADRAO_DEPOSIT` ou `PIX_PADRAO_TRANSFER`                        |
| `extraPercentFee` | Acréscimo % sobre a taxa principal (PIX entrada)                     |
| `extraFixedFee`   | Acréscimo fixo em R\$ somado à taxa principal                        |
| `useGlobal`       | Se `true`, ignora acréscimo desta linha e usa taxas globais da conta |
| `active`          | Padrão `true`                                                        |

<Note>
  Campos legados `percentFee` / `fixedFee` são aceitos como sinônimo de `extraPercentFee` / `extraFixedFee`. `profitPercent` e `profitFixed` foram descontinuados — o acréscimo configurado é creditado à conta principal.
</Note>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "message": "Taxas atualizadas",
    "data": {
      "rail": "PADRAO",
      "subaccountId": "clx_subconta",
      "lines": [
        {
          "operation": "PIX_PADRAO_DEPOSIT",
          "label": "PIX entrada (Padrão)",
          "extraPercentFee": 1.5,
          "extraFixedFee": 0.5,
          "totalPercentFee": 4.5,
          "totalFixedFee": 1,
          "useGlobal": false,
          "active": true
        }
      ]
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

Consulte também [GET /subaccount/pricing](/api-reference/endpoint/subaccount/pricing) para preview sem alterar cadastro.


## OpenAPI

````yaml POST /subaccount/set-pricing
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/set-pricing:
    post:
      tags:
        - subaccount
      summary: Taxas e lucro por operação
      operationId: setSubaccountPricing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetSubaccountPricing'
      responses:
        '200':
          $ref: '#/components/responses/SuccessEnvelope'
components:
  schemas:
    SetSubaccountPricing:
      type: object
      required:
        - id
        - lines
      properties:
        id:
          type: string
        lines:
          type: array
          items:
            $ref: '#/components/schemas/SubaccountPricingLine'
    SubaccountPricingLine:
      type: object
      required:
        - operation
      properties:
        operation:
          type: string
          enum:
            - PIX_PADRAO_DEPOSIT
            - PIX_PADRAO_TRANSFER
        extraPercentFee:
          type: number
        extraFixedFee:
          type: number
        useGlobal:
          type: boolean
        active:
          type: boolean
    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
  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
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````