Skip to main content
POST
/
subaccount
/
portal
/
setup
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/portal/setup' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalReference": "loja-parceiro-a",
    "email": "operador@empresa.com",
    "password": "SenhaForte!123"
  }'

{
  "success": true,
  "message": "Portal Wallet configurado",
  "data": {
    "success": true,
    "mode": "portal_ready"
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/subaccount/portal/setup' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalReference": "loja-parceiro-a",
    "email": "operador@empresa.com",
    "password": "SenhaForte!123"
  }'

{
  "success": true,
  "message": "Portal Wallet configurado",
  "data": {
    "success": true,
    "mode": "portal_ready"
  },
  "requestId": "req_abc123"
}
​
id
string
ID da subconta. Informe id ou externalReference.
​
externalReference
string
Referência externa da subconta.
​
email
string
required
E-mail de login (único na plataforma para portal).
​
password
string
required
Senha do operador (mín. 8 caracteres, maiúscula, minúscula, número e símbolo).
Permissão: subaccount/portal/setup. O operador entra imediatamente em wallet.goatpay.com.br/login — sem confirmação por e-mail.

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json

Informe id ou externalReference da subconta.

​
email
string<email>
required
​
password
string
required
Minimum string length: 8
​
id
string
​
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