API Reference

Consultar 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:

{
    "data": {
        "token": "0RJLvl0NrXoGHeYBPAZArTtirN41rnlAbw2N",
        "data_criacao": "2025-11-06T10:39:26.026849Z",
        "status_id": 11,
        "status": "PAGO",
        "valor": 10.52,
        "valor_frete": 0,
        "frete": false,
        "cliente_nome": "",
        "cliente_telefone": "",
        "cliente_email": "",
        "descricao": "",
        "usuario": "",
        "url": "https://gateway.fixpay.com.br/personpayment/0RJLvl0NrXoGHeYBPAZArTtirN41rnlAbw2N",
        "qtd_max_pagamentos": 1,
        "qtd_pagamentos": 0,
        "max_plano": 1,
        "plano": 1,
        "endereco": "",
        "cep": "0",
        "numero": "0",
        "complemento": "",
        "bairro": "",
        "cidade": "",
        "estado": "",
        "pais": "BR",
        "estabelecimento_id": 3833,
        "razao_social": "FIX TECNOLOGIA E DESENVOLVIMENTO DE SOFTWARES LTDA",
        "cpf_cnpj": "25406071000110",
        "data_pagamento": "2025-11-06T10:39:26Z",
        "titular_nome_cartao": "Maria dos Santos",
        "titular_cpf_cnpj": "",
        "natureza": "VENDA A CREDITO",
        "bandeira": "MASTERCARD",
        "antifraude": "SEM_ANTIFRAUDE",
        "numero_cartao": "123456XXXXXX1234",
        "nsu": "123456789",
        "tid": "74820519366248105739",
        "authorization": "123456",
        "reference": "teste-link-1234"
    }
}

Tabela de status

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!