Skip to main content

Consulta pagamento via PIX por ID

Consulta um faturamento de estadia realizado.

GET api/estadias_faturamentos/pix/<id>

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
id

Identificador único dado transaçãopagamento devia faturamento de estadia.pix.

 SIM

RETORNO EM CASO DE SUCESSO (200 – OK)

pagamento,ovalorserá
CHAVE
 DESCRIÇÃO
id
 Identificador único da transação de faturamento de estadia.
localizador Localizador da estadia.
entrada_datahoraData e hora de registro de entrada no estacionamento.
registro_datahoraData e hora de registro da transação na garagem.
validade_datahoraData e hora de validade para saída da garagem.
valor_pago Valor pago pela estadia.
documento_fiscal_numero
Número do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
tag
Identificador do integrador.
parceiro_idstatus
 Código0 do(pendente) parceiroe 1 (pago)
parceiro_identificacaoestadia_faturamento_id
 Identificação do parceiro
modalidade_pagamento_id
 Códigoenviado dasomente modalidadeno caso do status for igual a 1 (pago), com ele, poderá realizar a consulta no endpoint de pagamento
modalidade_pagamento_identificacao
Identificação da modalidadeConsulta de pagamento

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

{
    "estadia_faturamento": {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "localizador": "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",
        "documento_fiscal_numero": "000000123456",
        "tag": "ABCDEF0123456789",
        "parceiro_id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "parceiro_nome": "CIELO",
        "modalidade_pagamento_id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "modalidade_pagamento_nome": "CARTÃO"
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
400

Caso não seja recebido o parâmetro <id>.
401

Caso as credenciais sejam inválidas.
404

Caso o id da transação não seja encontrado.

Back to top