API Reference

Retorar link por reference

Consulta a transação através do seu número de Reference e token API do parceiro.

Exemplo de retorno desta requisição:

{
 "amount": 2.31,
 "amount_freight": 0.00,
 "client_email":
"[email protected]",
 "client_name": "Ariele Alves",
 "client_phone": "85999999999",
 "cpf_cnpj_holder": "50380628066",
 "created_at": "2025-04-23T11:15:45Z",
 "date_sale": "2025-04-23T11:15:45Z",
 "description": "",
 "estabelecimento_id": 123,
 "expiration_date": "0001-01-01T00:00:00Z",
 "freight": false,
 "grupo_id": 1234,
 "hash_itens": "",
 "id": 484763,
 "installments": 1,
 "max_installments": 0,
 "natureza_id": 17,
 "reference": "testeapi12345671",
 "status_id": 33,
 "tid": "",
 "token": "",
 "updated_at": "2025-04-23T11:15:45Z",
 "url": "",
 "usuario": "",
 "usuario_id": 0
 }

Tabela de status do link e seus respectivos detalhamentos

Status_IDDescriçãoDetalhamento
18NÃO AUTORIZADOO link com pagamento recusado
pela Rede, devido a falta de limite
no cartão ou por dados inseridos
incorretamente
36AGUARDANDO AUTENTICAÇÃOO link foi enviado para o desafio de
autenticação bancária
40FALHA NA AUTENTICAÇÃOLink no qual o usuário errou o
desafio de autenticação ou excedeu
o prazo para realizá-lo
33PROCESSO DE PAGAMENTOStatus do link após clicar no botão
pagar
11PAGOPagamento de link aprovado pela
Rede
28EXPIRADOLinks fechados ou abertos que não
realizaram o pagamento e que
atingiram o tempo de expiração de
24h após sua geração.
27SOLICITAÇÃO CANCELAMENTO
EM ANDAMENTO
Status de transição entre pago e
cancelamento aprovado. As
solicitaçodões de cancelamentos
realizadas no dia posterior as
vendas serão analisadas pelo
financeiro e podem demorar até 7
dias para serem efetivadas
41CANCELADO PELO CLIENTELink cancelado pela loja após o
pagamento do link ter sido efetivado
6CANCELADOCancelado via Backoffice.
(chargeback)
34CANCELAMENTO AUTOMÁTICOVendas que foram solicitadas o
cancelamento no do mesmo dia da
venda.
14CANCELAMENTO APROVADOSolicitações de cancelamento que
foram aprovadas pelo financeiro

É necessário passar o Token API do estabelecimento no header "Authorization", e no "Content-Type" preenchê-lo com o valor do conteúdo que está sendo enviado, neste caso usamos "application/json".

Abaixo temos um exemplo de como inserir estes dados usando JSON.

Language
Click Try It! to start a request and see the response here!