Skip to main content
POST
/
subaccount
/
remove-balance
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/remove-balance' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "clx_subconta", "amount": 50 }'

{
  "success": true,
  "message": "Saldo removido da subconta",
  "data": {
    "mainTransactionId": "clx_tx_main",
    "subTransactionId": "clx_tx_sub",
    "amount": 50
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/subaccount/remove-balance' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "clx_subconta", "amount": 50 }'

{
  "success": true,
  "message": "Saldo removido da subconta",
  "data": {
    "mainTransactionId": "clx_tx_main",
    "subTransactionId": "clx_tx_sub",
    "amount": 50
  },
  "requestId": "req_abc123"
}
​
id
string
required
ID da subconta origem.
​
amount
number
required
Valor em reais. Não pode exceder spendableWhite da subconta.
​
description
string
Descrição opcional.
​
externalReference
string
Idempotência (máx. 64).

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
​
amount
number
required
​
description
string
Maximum string length: 200
​
externalReference
string
Maximum string length: 64

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