Consultar por Token

Retorna os dados do Flashlink com base no token presente no link fornecido na rota. O token é formado pelos caracteres que aparecem após a última barra ("/") na URL gerada pela rota de criação de link.

Como implementar:

Primeiramente, é necessário passar o token API do estabelecimento no header "Authorization" juntamente com a adição do Content-type: application/json. Esse token é disponibilizado através do Suporte. Os contatos estão disponibilizados em nossa página Fix Pay.

Exemplo:

Agora, veremos um exemplo da requisição feita em JavaScript e seu resultado.

const options = {
  method: 'GET',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer 125SEBXXXXXX20150821',
    'Content-Type': 'application/json'
  }
};

fetch('https://apis.fixpay.com.br/v1/flashlink/bytoken/be58202a-85c9-49b7-ad72-a4e7ed52abc73', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

O retorno da requisição é um JSON contendo dados relevantes do Flashlink.

{
    "data": {
        "id": 211401,
        "estabelecimento_id": 539,
        "grupo_id": 427,
        "amount": 89.99,
        "installments": 0,
        "consulted": 1,
        "description": "",
        "device_name": "",
        "expiration_date": "0001-01-01T00:00:00Z",
        "hash_itens": "CgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCnsKICAibWF4X2luc3RhbGxtZW50cyI6ICIxMiIsCiAgIm1heF9hbW91bnQiOiAiMSIsCiAgImZyZWlnaHQiOiB0cnVlLAogICJhbW91bnRfZnJlaWdodCI6IDEwLjAwLAogICJpdGVtcyI6IFsKICAgIHsKICAgICAgIml0ZW1faWQiOiAiMSIsCiAgICAgICJpdGVtX25hbWUiOiAiYmx1c2EiLAogICAgICAiaXRlbV9kZXNjcmlwdGlvbiI6ICJibHVzYSBUYW1hbmhvIE0iLAogICAgICAiaXRlbV9xdWFudGl0eSI6IDEsCiAgICAgICJpdGVtX2Rpc2NvdW50IjogMTAsCiAgICAgICJpdGVtX3ByaWNlIjogNDkuOTkKICAgIH0sCiAgICB7CiAgICAgICJpdGVtX2lkIjogIjIiLAogICAgICAiaXRlbV9uYW1lIjogImNhbMOnYSIsCiAgICAgICJpdGVtX2Rlc2NyaXB0aW9uIjogImNhbMOnYSBqZWFucyIsCiAgICAgICJpdGVtX3F1YW50aXR5IjogMSwKICAgICAgIml0ZW1fZGlzY291bnQiOiAwLAogICAgICAiaXRlbV9wcmljZSI6IDUwCiAgICB9CiAgXQp9Cg==",
        "current_amount": 0,
        "max_amount": 1,
        "client_name": "",
        "client_email": "",
        "client_phone": "",
        "max_installments": 12,
        "order_id": "",
        "url": "https://gateway.fixpay.com.br/personpayment/be58202a-85c9-49b7-ad72-a4e7ed528d73",
        "date_sale": "0001-01-01T00:00:00Z",
        "freight": true,
        "amount_freight": 10.00,
        "token": "be58202a-85c9-49b7-ad72-a4e7ed528d73",
        "usuario_id": 0,
        "usuario": "SISTEMA",
        "natureza_id": 17,
        "status_id": 35,
        "created_at": "2024-01-31T13:11:43.637154Z",
        "updated_at": "0001-01-01T00:00:00Z",
        "replicado": false,
        "token_gerador": "",
        "FlashlinkPayment": {
            "id": 0,
            "flashlink_id": 0,
            "estabelecimento_id": 0,
            "grupo_id": 0,
            "request_json": "",
            "response_json": "",
            "amount": 0.00,
            "card_token": "",
            "installments": 0,
            "client_name": "",
            "client_email": "",
            "client_phone": "",
            "zip_code": "",
            "address": "",
            "number": 0,
            "complement": "",
            "neighborhood": "",
            "city": "",
            "state": "",
            "country": "",
            "tid": "",
            "reference": "",
            "card_number": "",
            "card_holder_name": "",
            "nsu": "",
            "authorization": "",
            "date_payment": "0001-01-01T00:00:00Z",
            "natureza_id": 0,
            "integradora_id": 0,
            "bandeira_id": 0,
            "captura_id": 0,
            "status_id": 0,
            "freight": false,
            "amount_freight": 0.00,
            "ip": "",
            "cpf_cnpj_holder": "",
            "antifraude": "",
            "created_at": "0001-01-01T00:00:00Z",
            "updated_at": "0001-01-01T00:00:00Z",
            "TotalAmount": 0.00,
            "Bandeira": {
                "id": 0,
                "descricao": "",
                "created_at": "0001-01-01T00:00:00Z",
                "updated_at": "0001-01-01T00:00:00Z"
            },
            "Token": "",
            "Fantasia": "",
            "Description": "",
            "LinkUrl": "",
            "UsuarioId": 0,
            "Usuario": "",
            "StatusDescricao": "",
            "FormaDePagamento": 0,
            "Consultado": 0,
            "OrderID": 0,
            "InstallmentsAmount": 0,
            "ErrorHistory": ""
        },
        "FlashlinkPayments": null
    }
}

A seguir, apresentam-se todos os possíveis status, parametro "status_id", que um Flashlink pode assumir:

Status_ID	Descrição
38	FECHADO.
35	ABERTO.
18	NÃO AUTORIZADO.
36	AGUARDANDO AUTENTICAÇÃO.
40	FALHA NA AUTENTICAÇÃO.
33	PROCESSO DE PAGAMENTO.
11	PAGO.
28	EXPIRADO.
27	SOLICITAÇÃO CANCELAMENTO EM ANDAMENTO.
41	CANCELADO PELO CLIENTE
6	CANCELADO
34	CANCELAMENTO AUTOMÁTICO
14	CANCELAMENTO APROVADO

Testar rota

Abaixo, você poderá testar a rota em produção, passando os valores nos parâmetros conforme sua descrição e tipo. Na lateral direita da tela, você poderá ver o código da requisição em várias linguagens diferentes e sua resposta. Além disso, na parte de resposta da requisição, você poderá ver todos os possíveis retornos gerados pela rota.