Documentação da API
Autenticação
Subcontas
Contas Bancárias
Clientes
Tokenização de Cartões
Assinaturas de Recorrência
Saldo e Transferências
Antecipações de Recebíveis
Webhooks
Subcontas
Detalhar subconta
Busca os dados de uma subconta específica que pertence à empresa cadastrada. A resposta inclui informações detalhadas da subconta, como dados do responsável legal, dados jurídicos (para PJ), endereços e status da conta.
GET
/
subaccounts
/
{subaccountId}
Copy
curl --request GET \
--url https://sandbox-api.superpagamentos.com/subaccounts/{subaccountId} \
--header 'Authorization: Bearer <token>'
Copy
{
"data": {
"id": "51bfa0f3-72f7-409f-8ac4-77b4611494b6",
"createdAt": "2025-05-28T18:06:43.846Z",
"name": "Empresa Teste LTDA",
"status": "PENDING",
"companyType": "PJ",
"juridicDataPartner": {
"name": "João",
"lastName": "Silva",
"cpf": "00000000000",
"email": "email@email.com",
"birthdate": "1990-05-20",
"contactPhone": "(00) 00000-0000",
"monthRevenue": 50000,
"jobOccupation": "Diretor Financeiro",
"fullnameMom": "Maria Silva"
},
"juridicLegalData": {
"cnpj": "00000000000000",
"contactPhone": "(00) 00000-0000",
"fantasyName": "Empresa Exemplo Ltda",
"socialReason": "Empresa Exemplo LTDA",
"avgAnualBilling": 1000000,
"searchingServices": "Consultoria Financeira",
"socialMedia": "@empresaexemplo"
},
"addresses": [
{
"addressType": "COMMERCIAL",
"zipcode": 12345678,
"street": "Rua A",
"streetNumber": 100,
"complement": "Sala 5",
"reference": "Próximo ao Shopping",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP"
}
]
},
"message": "Subconta encontrada com sucesso"
}
Authorizations
Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer <token>
Path Parameters
Identificador único da subconta
Response
200
application/json
Subconta encontrada com sucesso
The response is of type object
.
Copy
curl --request GET \
--url https://sandbox-api.superpagamentos.com/subaccounts/{subaccountId} \
--header 'Authorization: Bearer <token>'
Copy
{
"data": {
"id": "51bfa0f3-72f7-409f-8ac4-77b4611494b6",
"createdAt": "2025-05-28T18:06:43.846Z",
"name": "Empresa Teste LTDA",
"status": "PENDING",
"companyType": "PJ",
"juridicDataPartner": {
"name": "João",
"lastName": "Silva",
"cpf": "00000000000",
"email": "email@email.com",
"birthdate": "1990-05-20",
"contactPhone": "(00) 00000-0000",
"monthRevenue": 50000,
"jobOccupation": "Diretor Financeiro",
"fullnameMom": "Maria Silva"
},
"juridicLegalData": {
"cnpj": "00000000000000",
"contactPhone": "(00) 00000-0000",
"fantasyName": "Empresa Exemplo Ltda",
"socialReason": "Empresa Exemplo LTDA",
"avgAnualBilling": 1000000,
"searchingServices": "Consultoria Financeira",
"socialMedia": "@empresaexemplo"
},
"addresses": [
{
"addressType": "COMMERCIAL",
"zipcode": 12345678,
"street": "Rua A",
"streetNumber": 100,
"complement": "Sala 5",
"reference": "Próximo ao Shopping",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP"
}
]
},
"message": "Subconta encontrada com sucesso"
}
Assistant
Responses are generated using AI and may contain mistakes.