Skip to main content
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_WHITE_DEPOSIT",
        "extraPercentFee": 1.5,
        "extraFixedFee": 0.50,
        "useGlobal": false
      },
      {
        "operation": "PIX_WHITE_TRANSFER",
        "extraFixedFee": 1.00,
        "useGlobal": false
      }
    ]
  }'
{
  "success": true,
  "message": "Taxas atualizadas",
  "data": {
    "rail": "PADRAO",
    "subaccountId": "clx_subconta",
    "lines": [
      {
        "operation": "PIX_WHITE_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_WHITE_DEPOSIT",
        "extraPercentFee": 1.5,
        "extraFixedFee": 0.50,
        "useGlobal": false
      },
      {
        "operation": "PIX_WHITE_TRANSFER",
        "extraFixedFee": 1.00,
        "useGlobal": false
      }
    ]
  }'
id
string
required
ID da subconta.
lines
array
required
Regras de acréscimo. Apenas PIX_WHITE_DEPOSIT (PIX entrada) e PIX_WHITE_TRANSFER (PIX saída).
CampoDescrição
operationPIX_WHITE_DEPOSIT ou PIX_WHITE_TRANSFER
extraPercentFeeAcréscimo % sobre a taxa principal (PIX entrada)
extraFixedFeeAcréscimo fixo em R$ somado à taxa principal
useGlobalSe true, ignora acréscimo desta linha e usa taxas globais da conta
activePadrã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_WHITE_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
id
string
required
lines
object[]
required

Response

200 - application/json

Operação concluída.

success
boolean
required
Example:

true

message
string
required
Example:

"Pagamento PIX criado com sucesso"

data
object
required
requestId
string