Retorna a lista de consentimentos de um parceiro que estão associados a um merchant identificado por documento.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Este é um endpoint público (sem autenticação) que permite consultar todos os consentimentos de um merchant. É útil para:
- Verificar o status de consentimentos antes de fazer novos pedidos, para evitar sobrecarregar o lojista com muitos e-mails desnecessários.
- Diagnosticar problemas de recebimento de e-mail ou webhook.
- Verificar qual o identificador dos consentimentos para facilitar a busca em sistemas internos dos integradores.
Query params
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
clientId | string | ✅ | Identificador do parceiro que está fazendo a requisição. |
document | string | ✅ | CNPJ (14 dígitos) ou CPF (11 dígitos) do merchant, sem pontos, hífen ou barra. |
Exemplo: GET /v2/merchant/consents/status?clientId=app-123&document=12345678000190
O resultado será informado através do código de status HTTP da resposta.
| HTTP Status Code | Descrição |
|---|---|
| 200 | Sucesso. Retorna a lista de consentimentos. |
| 400 | Erro nos dados informados para a API. |
| 404 | Erro no formato da URL ou no método enviado |
| 429 | Limite de requisições excedido, máximo de 7 requisições por hora para um mesmo par de clientId e documento. |
| 500 | Ocorreu um erro interno na API, por favor nos informe |
| 502 | Um dos sistemas da Stone falhou, por favor nos informe |
Resposta 200 — lista de consentimentos
Retorna um array com no máximo 100 consentimentos, ordenados do mais recente para o mais antigo por createdAt.
[
{
"consentId": "6a187fc840aa10c116048933",
"status": "pending",
"createdAt": "2026-05-28T17:47:52.671Z",
"updatedAt": "2026-05-28T17:47:52.671Z"
},
{
"consentId": "6a187fa540aa10c116048932",
"status": "accepted",
"createdAt": "2026-05-28T17:47:17.439Z",
"updatedAt": "2026-05-28T17:48:04.48Z"
}
]Quando não há consentimentos para o merchant:
[]Status de consentimento
| Status | Descrição |
|---|---|
pending | Aguardando ação do merchant (aprovação ou rejeição) |
accepted | Merchant aprovou o consentimento |
active | Consentimento ativo e em uso |
denied | Merchant rejeitou o consentimento |
revoked | Consentimento revogado (aprovação anterior cancelada) |
Limite de resultados: O endpoint retorna no máximo 100 consentimentos por chamada, ordenados pelos mais recentes. Não há suporte a paginação. Na prática, a maioria dos merchants tem menos de 100 consentimentos, quantidades acima disso indica um uso indevido da API.
Ao atingir o limite de 7 requisições por hora para uma mesma combinação de
clientIdedocument, a API retornará429 Too Many Requests. Aguarde o reset da janela de 1 hora antes de realizar novas requisições.
404Not Found
429Too Many Requests
500Internal Server Error
502Bad Gateway

