Consultar taxas da subconta

Consultar taxas PIX da subconta

curl --request GET \
  --url https://api.goatpay.com.br/v1/subaccount/pricing \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "message": "OK",
  "data": {
    "rail": "PADRAO",
    "subaccountId": "clx_subconta",
    "lines": [
      {
        "operation": "PIX_WHITE_DEPOSIT",
        "label": "PIX entrada (Padrão)",
        "mainPercentFee": 3,
        "mainFixedFee": 0.5,
        "extraPercentFee": 0.5,
        "extraFixedFee": 0,
        "totalPercentFee": 3.5,
        "totalFixedFee": 0.5,
        "useGlobal": false,
        "active": true
      },
      {
        "operation": "PIX_WHITE_TRANSFER",
        "label": "PIX saída (Padrão)",
        "mainPercentFee": 0,
        "mainFixedFee": 2,
        "extraPercentFee": 1,
        "extraFixedFee": 0.5,
        "totalPercentFee": 1,
        "totalFixedFee": 2.5,
        "useGlobal": false,
        "active": true
      }
    ]
  },
  "requestId": "req_abc"
}

GET

subaccount

pricing

Consultar taxas PIX da subconta

curl --request GET \
  --url https://api.goatpay.com.br/v1/subaccount/pricing \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "message": "OK",
  "data": {
    "rail": "PADRAO",
    "subaccountId": "clx_subconta",
    "lines": [
      {
        "operation": "PIX_WHITE_DEPOSIT",
        "label": "PIX entrada (Padrão)",
        "mainPercentFee": 3,
        "mainFixedFee": 0.5,
        "extraPercentFee": 0.5,
        "extraFixedFee": 0,
        "totalPercentFee": 3.5,
        "totalFixedFee": 0.5,
        "useGlobal": false,
        "active": true
      },
      {
        "operation": "PIX_WHITE_TRANSFER",
        "label": "PIX saída (Padrão)",
        "mainPercentFee": 0,
        "mainFixedFee": 2,
        "extraPercentFee": 1,
        "extraFixedFee": 0.5,
        "totalPercentFee": 1,
        "totalFixedFee": 2.5,
        "useGlobal": false,
        "active": true
      }
    ]
  },
  "requestId": "req_abc"
}

string

ID da subconta (clx_…).

externalReference

string

Referência externa cadastrada no create (alternativa ao id).

{
  "success": true,
  "message": "OK",
  "data": {
    "rail": "PADRAO",
    "subaccountId": "clx_subconta",
    "lines": [
      {
        "operation": "PIX_WHITE_DEPOSIT",
        "label": "PIX entrada (Padrão)",
        "mainPercentFee": 3,
        "mainFixedFee": 0.5,
        "extraPercentFee": 0.5,
        "extraFixedFee": 0,
        "totalPercentFee": 3.5,
        "totalFixedFee": 0.5,
        "useGlobal": false,
        "active": true
      },
      {
        "operation": "PIX_WHITE_TRANSFER",
        "label": "PIX saída (Padrão)",
        "mainPercentFee": 0,
        "mainFixedFee": 2,
        "extraPercentFee": 1,
        "extraFixedFee": 0.5,
        "totalPercentFee": 1,
        "totalFixedFee": 2.5,
        "useGlobal": false,
        "active": true
      }
    ]
  },
  "requestId": "req_abc"
}

Requer permissão subaccount/get (ou equivalente na chave). Subconta deve estar ACTIVE para operações; consulta de pricing aceita subconta inativa se ainda existir no cadastro.

Authorizations

X-API-Key

string

header

required

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

Query Parameters

string

externalReference

string

Response

Operação concluída.

success

boolean

required

Example:

true

message

string

required

Example:

"Pagamento PIX criado com sucesso"

data

object

required

requestId

string

Taxas