Consulta os dados de um Flashlink através do Token do link.
Retornar Link 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.
Observação:
Esta API utiliza cache como recurso de otimização da mesma. O status 11 (PAGO) é atualizado em tempo real e os demais status possuem uma variação de tempo de 20 minutos para sua atualização.
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/link/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 Link.
{
"data": {
"id": 314225,
"estabelecimento_id": 539,
"grupo_id": 427,
"amount": 1,
"installments": 0,
"consulted": 1,
"description": "",
"device_name": "",
"expiration_date": "0001-01-01T00:00:00Z",
"hash_itens": "eyJtYXhfYW1vdW50IjoiMSIsIm1heF9pbnN0YWxsbWVudHMiOiIxIiwiZnJlaWdodCI6ZmFsc2UsImFtb3VudF9mcmVpZ2h0IjowLCJpdGVtcyI6W3siaXRlbV9pZCI6IjEiLCJpdGVtX25hbWUiOiJ0ZXN0ZSIsIml0ZW1fZGVzY3JpcHRpb24iOiJ0ZXN0ZSIsIml0ZW1fcXVhbnRpdHkiOjEsIml0ZW1fZGlzY291bnQiOjAsIml0ZW1fcHJpY2UiOjF9XX0=",
"current_amount": 1,
"max_amount": 1,
"client_name": "",
"client_email": "",
"client_phone": "",
"max_installments": 1,
"order_id": "",
"url": "https://gateway.fixpay.com.br/personpayment/035578000e8da7183424e0xxxba",
"date_sale": "0001-01-01T00:00:00Z",
"freight": false,
"amount_freight": 0,
"token": "",
"usuario_id": 402,
"usuario": "",
"natureza_id": 17,
"status_id": 41,
"created_at": "2024-08-06T15:28:34.018676Z",
"updated_at": "0001-01-01T00:00:00Z",
"replicado": false,
"token_gerador": "",
"cpf_cnpj_holder": "",
"payments": [
{
"id": 263904,
"flashlink_id": 314225,
"estabelecimento_id": 539,
"grupo_id": 427,
"request_json": "",
"response_json": "",
"amount": 1,
"card_token": "",
"installments": 1,
"client_name": "",
"client_email": "fixpay@gmail.com",
"client_phone": "",
"zip_code": "0",
"address": "",
"number": 0,
"complement": "",
"neighborhood": "",
"city": "",
"state": "",
"country": "",
"tid": "",
"reference": "",
"card_number": "",
"card_holder_name": "",
"nsu": "127xxxxx",
"authorization": "",
"date_payment": "2024-08-06T15:29:15.873398Z",
"natureza_id": 17,
"integradora_id": 0,
"bandeira_id": 2,
"captura_id": 0,
"status_id": 41,
"freight": false,
"amount_freight": 0,
"ip": "",
"cpf_cnpj_holder": "",
"antifraude": "",
"created_at": "2024-08-06T15:29:15.873399Z",
"updated_at": "2024-08-06T15:40:24.193958Z",
"TotalAmount": 0,
"Bandeira": {
"id": 2,
"descricao": "MASTERCARD",
"created_at": "0001-01-01T00:00:00Z",
"updated_at": "0001-01-01T00:00:00Z"
},
"Token": "00000xxxxxxxxxxxxxxxx",
"Fantasia": "empresa teste",
"Description": "",
"LinkUrl": "https://gateway.fixpay.com.br/personpayment/035578000e8da7183424e0bb707xxa",
"UsuarioId": 402,
"Usuario": "",
"StatusDescricao": "",
"FormaDePagamento": 0,
"Consultado": 0,
"OrderID": 0,
"InstallmentsAmount": 0,
"ErrorHistory": ""
}
]
}
}
A seguir, apresentam-se todos os possíveis status, parametro "status_id", que um Flashlink pode assumir:
| Status_ID | Descrição | Detalhamento |
|---|---|---|
| 38 | FECHADO | O link nunca foi aberto |
| 35 | ABERTO | O link foi aberto, mas ainda não foi clicado no botão "Pagar" |
| 18 | NÃO AUTORIZADO | O link com pagamento recusado pela Rede, devido a falta de limite no cartão ou por dados inseridos incorretamente |
| 36 | AGUARDANDO AUTENTICAÇÃO | O link foi enviado para o desafio de autenticação bancária |
| 40 | FALHA NA AUTENTICAÇÃO | Link no qual o usuário errou o desafio de autenticação ou excedeu o prazo para realizá-lo |
| 33 | PROCESSO DE PAGAMENTO | Status do link após clicar no botão pagar |
| 11 | PAGO | Pagamento de link aprovado pela Rede |
| 28 | EXPIRADO | Links fechados ou abertos que não realizaram o pagamento e que atingiram o tempo de expiração de 24h após sua geração. |
| 27 | SOLICITAÇÃ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 |
| 41 | CANCELADO PELO CLIENTE | Link cancelado pela loja após o pagamento do link ter sido efetivado |
| 6 | CANCELADO | Cancelado via Backoffice. (chargeback) |
| 34 | CANCELAMENTO AUTOMÁTICO | Vendas que foram solicitadas o cancelamento no do mesmo dia da venda. |
| 14 | CANCELAMENTO APROVADO | Solicitações de cancelamento que foram aprovadas pelo financeiro |
No fluxo abaixo, é possível visualizar a relação dos status do link listados acima:
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.