Skip to main content

Consulta pagamentos com filtros

Lista um ou mais pagamentos registrados pelo integrador através de filtros de seleção, que limitam o resultado e podem ser zero ou mais dentre período, ticket e tag. Os parâmetros inicio_datahora e fim_datahora limitam o resultado pelo campo registro_datahora. O parâmetro ticket limita o resultado pelo campo ticket. O parâmetro tag limita o resultado pelo campo tag. Caso eles não sejam informados, a resposta é gerada sem a aplicação dos filtros. Para não sobrecarregar as respostas geradas, o sistema faz automaticamente paginação dos dados e fornece os links para navegação entre as páginas. Caso os parâmetros page e per_page não sejam informados, os valores 1 e 20 são associados, respectivamente, aos parâmetros. Os links de navegação são retornados no header, seguindo a especificação RFC-8288.

GET api/integradores/permanencia_pagamentos

HEADERS

CHAVE
 VALOR
 DESCRIÇÃO
 OBRIGATÓRIO
Accept
 application/vnd.linkc.com.br; version=1 Versão da API. SIM
Authorization
 Bearer <TOKEN>
 Token obtido na autenticação
 SIM
Content-Type
 application/json
 Tipo de conteúdo do request
 SIM

PARÂMETROS QUERY STRING

CHAVE
 DESCRIÇÃO
 OBRIGATÓRIO

page

Número da página da listagem dos pagamentos.

 NÃO

per_page

Quantidade de registros por página.

 NÃO

inicio_datahora

Horário inicial do período de consulta.

 NÃO

fim_datahora

Horário final do período de consulta.

 NÃO

ticket

Número do ticket.

 NÃO

tag

 Nome e sobrenome do portador, separado por espaço simples. NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO

permanencia_pagamentos

Lista de pagamentos contento, cada entrada, os mesmos campos retornados pelo serviço /permanencia_pagamento/<id>.

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "permanencia_pagamentos": [
        {
            "id": "69d5b2f7",
            "ticket": "1234567890",
            "entrada_datahora": "2019-08-30T18:35:25.000-03:00",
            "registro_datahora": "2019-08-30T20:49:20.000-03:00",
            "validade_datahora": "2019-08-30T21:35:25.000-03:00",
            "valor_pago": "5.0",
            "autorizacao": "12345678",
            "transacao": "1234567890",
            "retorno_codigo": "4",
            "retorno_mensagem": "Operation Successful",
            "rps_numero": "000000123456",
            "nfce_qrcode": "http://dec.fazenda.uf.gov.br/ConsultarNFCe.aspx?p=5019131613336820762580901",
            "nfce_chave_acesso": "38010022300500997503763196132135776124080302",
            "tag": "ABCDEF0123456789"
        }, …
    ]
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
401
 Caso as credenciais sejam inválidas.

Back to top