Definir taxas da subconta

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
      }
    ]
  }'

{
  "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"
}

POST

subaccount

set-pricing

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
      }
    ]
  }'

{
  "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"
}

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.

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
      }
    ]
  }'

string

required

ID da subconta.

array

required

Regras de acréscimo. Apenas PIX_PADRAO_DEPOSIT (PIX entrada) e PIX_PADRAO_TRANSFER (PIX saída).

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`

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.

{
  "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"
}

Consulte também GET /subaccount/pricing para preview sem alterar cadastro.

Authorizations

X-API-Key

string

header

required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json

string

required

lines

object[]

required

Show child attributes

Response

200 - application/json

Operação concluída.

success

boolean

required

Example:

true

message

string

required

Example:

"Operação concluída com sucesso"

data

object

required

requestId

string

Limites Obter taxas

Introdução

Webhooks

PIX

Conta

Loja

Subcontas

Definir taxas da subconta

Authorizations

Body

Response