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

{
  "success": true,
  "message": "Subconta bloqueada",
  "data": {
    "id": "clx_subconta",
    "name": "Loja Parceiro",
    "status": "ACTIVE",
    "lockMode": "WITHDRAW_ONLY",
    "balance": {
      "availableWhite": 1500,
      "pendingWhite": 0,
      "lockedWhite": 0,
      "spendableWhite": 1500
    }
  },
  "requestId": "req_abc"
}

curl -X POST 'https://api.goatpay.com.br/v1/subaccount/lock' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "clx_subconta", "mode": "withdraw_only" }'
​
id
string
required
ID da subconta.
​
mode
string
required
full, withdraw_only ou deposit_only. Veja tabela no guia.
{
  "success": true,
  "message": "Subconta bloqueada",
  "data": {
    "id": "clx_subconta",
    "name": "Loja Parceiro",
    "status": "ACTIVE",
    "lockMode": "WITHDRAW_ONLY",
    "balance": {
      "availableWhite": 1500,
      "pendingWhite": 0,
      "lockedWhite": 0,
      "spendableWhite": 1500
    }
  },
  "requestId": "req_abc"
}

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
​
mode
enum<string>
required
Available options:
full,
withdraw_only,
deposit_only

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