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 do pagamento via pix.

SIM

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
DESCRIÇÃO
id
Identificador único da transação de faturamento de estadia.
localizador Localizador da estadia.
valor_pago Valor pago pela estadia.
tag
Identificador do integrador.
status
0 (pendente) e 1 (pago)
estadia_faturamento_id
Identificação do faturamento de estadia, o valor será enviado somente no caso do status for igual a 1 (pago), com ele, poderá realizar a consulta no endpoint de Consulta faturamento de estadia por ID

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.