Skip to main content
GET
/
subaccount
/
list
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/list?page=1&limit=20&status=ACTIVE' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Subcontas",
  "data": {
    "items": [
      {
        "id": "clx_subconta",
        "name": "Loja Parceiro A",
        "externalReference": "loja-parceiro-a",
        "status": "ACTIVE",
        "lockMode": "NONE",
        "balance": {
          "availableWhite": 1500,
          "pendingWhite": 0,
          "lockedWhite": 0,
          "spendableWhite": 1500
        }
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/subaccount/list?page=1&limit=20&status=ACTIVE' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Subcontas",
  "data": {
    "items": [
      {
        "id": "clx_subconta",
        "name": "Loja Parceiro A",
        "externalReference": "loja-parceiro-a",
        "status": "ACTIVE",
        "lockMode": "NONE",
        "balance": {
          "availableWhite": 1500,
          "pendingWhite": 0,
          "lockedWhite": 0,
          "spendableWhite": 1500
        }
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc123"
}

​
Query

​
page
integer
Página (padrão 1).
​
limit
integer
Itens por página (máx. 100, padrão 20).
​
status
string
ACTIVE ou DISABLED. Subcontas excluídas não aparecem na listagem.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
page
integer
Required range: x >= 1
​
limit
integer
Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
ACTIVE,
DISABLED

Response

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Pagamento PIX criado com sucesso"

​
data
object
required
​
requestId
string