Skip to main content
POST
/
subaccount
/
update
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/update' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "clx_subconta", "name": "Loja A — filial" }'
{
  "success": true,
  "message": "Subconta atualizada",
  "data": {
    "id": "clx_subconta",
    "name": "Loja A — filial",
    "externalReference": "loja-parceiro-a",
    "status": "ACTIVE",
    "lockMode": "NONE"
  },
  "requestId": "req_abc123"
}
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/update' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "clx_subconta", "name": "Loja A — filial" }'
{
  "success": true,
  "message": "Subconta atualizada",
  "data": {
    "id": "clx_subconta",
    "name": "Loja A — filial",
    "externalReference": "loja-parceiro-a",
    "status": "ACTIVE",
    "lockMode": "NONE"
  },
  "requestId": "req_abc123"
}
id
string
required
ID da subconta.
name
string
Novo nome (máx. 120).
status
string
ACTIVE ou DISABLED.

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
name
string
Maximum string length: 120
status
enum<string>
Available options:
ACTIVE,
DISABLED

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