Skip to content

Consultar Sub-conta

Consulta os dados e saldo de uma sub-conta.

GET /api/customer/

Endpoint

GET https://api.divipay.com.br/api/customer/{id}

Headers

HeaderValorObrigatório
AuthorizationBearerSim

Path Parameters

ParâmetroTipoDescrição
idstringID da sub-conta

Exemplo de Requisição

bash
curl -X GET https://api.divipay.com.br/api/customer/sub_abc123 \
  -H "Authorization: Bearer SEU_TOKEN"
javascript
const response = await fetch(
  'https://api.divipay.com.br/api/customer/sub_abc123',
  {
    headers: {
      'Authorization': 'Bearer SEU_TOKEN'
    }
  }
);

const customer = await response.json();

Resposta de Sucesso

Status: 200 OK

json
{
  "id": "sub_abc123",
  "name": "João Silva",
  "email": "joao@email.com",
  "document": "12345678901",
  "phone": "11999999999",
  "balance": 1500.00,
  "blockedBalance": 0.00,
  "status": 1,
  "taxes": [
    {
      "id": "tax_pix",
      "name": "Pix",
      "percent": 0.99
    }
  ]
}

Status da Sub-conta

StatusDescrição
0Inativo
1Ativo
2Pendente
9Excluído

Exemplo de Uso

javascript
async function getCustomerBalance(customerId) {
  const response = await fetch(
    `https://api.divipay.com.br/api/customer/${customerId}`,
    {
      headers: { 'Authorization': `Bearer ${token}` }
    }
  );

  const customer = await response.json();
  
  return {
    available: customer.balance - customer.blockedBalance,
    blocked: customer.blockedBalance,
    total: customer.balance
  };
}

Próximos Passos

Documentação da API DiviPay