Consulta os dados do link através do Id do estabelecimento
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retornar Link por Estabelecimento
Retorna os dados do link com base no estabelecimento presente no token api fornecido na header.
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/establishment', 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": 422330,
"estabelecimento_id": 539,
"grupo_id": 427,
"amount": 100000.00,
"installments": 0,
"consulted": 1,
"description": "",
"device_name": "",
"expiration_date": "0001-01-01T00:00:00Z",
"hash_itens": "eyJtYXhfYW1vdW50IjoiMSIsIm1heF9pbnN0YWxsbWVudHMiOiIxIiwiZnJlaWdodCI6ZmFsc2UsImFtb3VudF9mcmVpZ2h0IjowLCJpdGVtcyI6W3siaXRlbV9pZCI6IjE0NSIsIml0ZW1fbmFtZSI6IkNVUlNPIERFIENBQkVMTyIsIml0ZW1fZGVzY3JpcHRpb24iOiJDQUJFTE8iLCJpdGVtX3F1YW50aXR5IjoxMDAsIml0ZW1fZGlzY291bnQiOjAsIml0ZW1fcHJpY2UiOjEwMDB9XX0=",
"current_amount": 0,
"max_amount": 1,
"client_name": "",
"client_email": "",
"client_phone": "",
"max_installments": 1,
"order_id": "",
"url": "https://gateway.fixpay.com.br/personpayment/140101c1e25e21a35a05a2f73b4eee23",
"date_sale": "0001-01-01T00:00:00Z",
"freight": false,
"amount_freight": 0.00,
"token": "140101c1e25e21a35a05a2f73b4eee23",
"usuario_id": 17857,
"usuario": "TESTE",
"natureza_id": 17,
"status_id": 28,
"created_at": "2024-11-27T16:57:36.580356Z",
"updated_at": "0001-01-01T00:00:00Z",
"replicado": false,
"token_gerador": "",
"cpf_cnpj_holder": "",
"codigo_link_cliente": ""
}
]
}
Caso seja processado um pagamento, é incluso uma lista Payments com um objeto contendo informações sobre a transação.
{
"data": [
{
"id": 419876,
"estabelecimento_id": 539,
"grupo_id": 427,
"amount": 15.99,
"installments": 2,
"consulted": 1,
"description": "TESTE",
"device_name": "",
"expiration_date": "0001-01-01T00:00:00Z",
"hash_itens": "",
"current_amount": 0,
"max_amount": 1,
"client_name": "",
"client_email": "",
"client_phone": "",
"max_installments": 0,
"order_id": "",
"url": "https://gateway.fixpay.com.br/payment/1f5ce3e9cd4e01b8331d8ce236395ebd",
"date_sale": "0001-01-01T00:00:00Z",
"freight": false,
"amount_freight": 0.00,
"token": "1f5ce3e9cd4e01b8331d8ce236395ebd",
"usuario_id": 402,
"usuario": "",
"natureza_id": 17,
"status_id": 11,
"created_at": "2024-11-26T11:59:07.295543Z",
"updated_at": "0001-01-01T00:00:00Z",
"replicado": false,
"token_gerador": "",
"cpf_cnpj_holder": "",
"codigo_link_cliente": "",
"payments": [
{
"id": 46564,
"estabelecimento_id": 539,
"grupo_id": 427,
"amount": 15.99,
"description": "TESTE",
"reference": "xDHRj1WSF5CxFg6P",
"client_name": "",
"client_email": "",
"client_phone": "",
"installments": 2,
"address": "",
"number": 0,
"complement": "",
"neighborhood": "",
"city": "",
"state": "",
"zip_code": "",
"tid": "123456789101112131415",
"card_number": "123456XXXXXX10115",
"card_holder_name": "",
"nsu": "123456789",
"authorization": "123456",
"integradora_id": 1,
"bandeira_id": 1,
"date_sale": "2024-11-26T12:00:08Z",
"ip": "177.25.120.62",
"cpf_cnpj_holder": "",
"antifraude": "",
"natureza_id": 17,
"status_id": 11,
"usuario_id": 402,
"created_at": "2024-11-26T12:00:09Z",
"updated_at": "2024-11-27T12:00:32.693085Z",
"max_installments": 0,
"expiration": "0001-01-01T00:00:00Z",
"url": "",
"link_url": "",
"amount_freight": 0.00,
"freight": false,
"fantasia_estabelecimento": "",
"usuario": "",
"flashlink_id": 419876
}
]
}
]
}
A seguir, apresentam-se todos os possíveis status, parâmetro "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 |
No fluxo abaixo, é possível visualizar a relação dos status acima listados:
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.