Pular para o conteúdo principal

Buscar Owner Detail

Descrição: Retorna o owner detail cadastrado para a cooperativa. Existe um único registro por cooperativa, e a resposta é um objeto, não uma lista.

Endpoint​

GET/api/v1/integration/owner-details

Exemplo de Requisição​

curl -X GET \
-H "Authorization: {SUA_API_KEY}" \
"https://api.merx.tech/api/v1/integration/owner-details"

Parâmetros​

Parâmetros de Cabeçalho​

NomeDescriçãoTipoObrigatório
AuthorizationChave de API obtida via support-api@merx.techStringSim

Respostas​

  • 200 - Ok
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hmac_secret": "string",
"created_at": 1709837511.870898,
"updated_at": 1709837511.870898
}
CampoObservação
idIdentificador do owner detail. É o valor usado no PUT /api/v1/integration/owner-details/{id} — o cadastro (POST) responde 201 sem corpo e não devolve o id.
hmac_secretSegredo usado para assinar as entregas de webhook (header Content-Hmac). Retorna em texto claro, como foi cadastrado. Não serve para o parceiro validar a entrega — a assinatura é calculada sobre a mensagem interna e o corpo entregue é reserializado depois, então os bytes assinados não são os bytes recebidos. Detalhes no Guia: Webhooks.
created_at / updated_atTimestamps em epoch com segundos decimais (segundos desde 1970-01-01 UTC, com a fração após o ponto), e não em texto ISO-8601.

Campos nulos são omitidos da resposta.

  • 400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
  • 401 - Unauthorized

Devolvido pelo gateway quando o Authorization está ausente ou inválido — nesse caso a resposta traz corpo, no formato {"data": [], "error": {...}}. A mensagem dentro de error varia conforme o plugin de autenticação da rota, então não programe em cima do texto.

  • 404 - Not Found

Sem corpo. A cooperativa não tem owner detail cadastrado. Nesse caso a cooperativa não tem hmac_secret cadastrado.