Pedido de consentimento

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

O resultado será informado através do código de status HTTP da resposta.

HTTP Status CodeDescrição
201Pedido de consentimento criado. O e-mail de solicitação foi enviado para o lojista, para que ele conceda o acesso ou não.
400Erro nos dados informados para a API
404Erro no formato da URL ou no método enviado
500Ocorreu um erro interno na API, por favor nos informe
503Um dos sistemas da Stone falhou, por favor nos informe
504Ocorreu um timeout e não foi possível concluir o trabalho, tente novamente

Após o envio da requisição, a Stone enviará um evento de consentimento para a webhookUrl informada.

  • Inicialmente, o status do evento será pending, indicando que o pedido de consentimento está aguardando a decisão do lojista.
  • Se o lojista recusar o pedido, um novo evento será enviado com o status denied.
  • Caso o lojista aprove o consentimento, o status será accepted. Neste caso, o payload do evento incluirá tambémusername e password necessários para gerar o token de acesso e, por conseguinte, solicitar o arquivo de conciliação.
📘

Autenticação por documento

Esse fluxo garante que o acesso ao arquivo de conciliação só será liberado após a aprovação explícita do lojista responsável pelo documento informado.

No caso de extração por Stone Code, o Stone Code utilizado deve estar vinculado ao mesmo documento para o qual o consentimento foi solicitado.

A autorização é concedida para o documento, ou seja, um mesmo par de username e client_id, e posteriormente um token de acesso, devem ser utilizados para extração do arquivo de todos os Stone Codes associados a esse documento.

⚠️

O recomendado é a utilização mesma URL de webhook para receber as credenciais de todos os lojistas. Caso exista a necessidade de utilizar URLs diferentes, será necessário aguardar 10 minutos, pois existe um cache por clientId que não permitirá o envio para a nova URL antes desse prazo.

⚠️

Não armazenamos os usernamee password gerados, essa informação é recebida exclusivamente pelo integrador em sua webhookUrl e devem ser armazenados pelo mesmo. Em caso de perda dessas informações, não é possível recuperá-las. Para obter novas credenciais, será necessário realizar um novo pedido de consentimento. Após a aprovação do lojista, as credenciais serão entregues novamente via webhook.

Devido a uma atualização na infraestrutura Stone, credenciamentos criados a partir de setembro de 2026 começaram a ter novos identificadores, deixando de possuir um StoneCode (affiliationCode).
Essa atualização está sendo aplicada de forma gradual: durante o período de transição, alguns estabelecimentos ainda podem ser credenciados no modelo anterior.

O parâmetro affiliationCode continua sendo obrigatório somente para clientes que possuem StoneCode, caso contrário, basta passar o documento.
Caso seu cliente possua um StoneCode e ele não seja passado como parâmetro, será retornado o erro "AffiliationCode is required for this merchant".

Body Params
string
required
string
required
string
required
string

(Obrigatório somente para clientes que possuem StoneCode)

string
required
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json