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
- Java
- JavaScript
- Python
- SDK Java
curl -X GET \
-H "Authorization: {SUA_API_KEY}" \
"https://api.merx.tech/api/v1/integration/owner-details"
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.merx.tech/api/v1/integration/owner-details"))
.header("Authorization", "{SUA_API_KEY}")
.GET()
.build();
HttpClient client = HttpClient.newHttpClient();
try {
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
const response = await fetch(
'https://api.merx.tech/api/v1/integration/owner-details',
{
method: 'GET',
headers: {
'Authorization': '{SUA_API_KEY}',
},
}
);
const data = await response.json();
console.log(data);
import requests
url = "https://api.merx.tech/api/v1/integration/owner-details"
headers = {
"Authorization": "{SUA_API_KEY}",
}
response = requests.get(url, headers=headers)
print(response.json())
import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
MerxClient merx = MerxClient.builder()
.apiKey("{SUA_API_KEY}")
.environment(Environment.SANDBOX)
.build();
var detail = merx.ownerDetails().get().orElseThrow();
Parâmetros
Parâmetros de Cabeçalho
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Authorization | Chave de API obtida via support-api@merx.tech | String | Sim |
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
}
| Campo | Observação |
|---|---|
id | Identificador 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_secret | Segredo 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_at | Timestamps 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.