Skip to main content

Consulta status pagamento por pix por ID de transação

Consulta status do pagamento realizado via pix.

GET api/integradores/pagamentos_pix_em_processamento/<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 da transação de pagamento.

SIM

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
DESCRIÇÃO
id
Identificador único da transação de pagamento.
registro_datahora  Data e hora de registro da transação na garagem.
valor_pago  Valor pago.
autorizacao
Identificação de autorização do pagamento na adquirente.
transacao
Identificação de transação do pagamento no adquirente.
retorno_codigo
Código de retorno do adquirente da transação de pagamento.
retorno_mensagem
Mensagem de retorno do adquirente da transação de pagamento.
rps_numero
Número do RPS gerado na garagem. Caso a garagem não emita RPS, este parâmetro não é retornado.
nfce_qrcode
URL de consulta da NFC-e. Será gerado somente quando a garagem for obrigada a emitir NFC-e.
nfce_chave_acesso
Chave de acesso de consulta NFC-e. Será gerado somente quando a garagem for obrigada a emitir NFC-e.
tag
Identificador do integrador.
status
1 - Pago / 2 - Pendente / 3 - Cancelado
tipo
PIX

EXEMPLO DE RETORNO EM CASO DE SUCESSO PARA PAGAMENTO PAGO (200 – OK)

{
    "pagamentos_pix": {
        "id": "69d5b2f7",
        "registro_datahora": "2019-08-30T20:49:20.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",
        "status": "1",
        "tipo": "PIX"
    }
}

EXEMPLO DE RETORNO EM CASO DE SUCESSO PARA PAGAMENTO PENDENTE (200 – OK)

{
    "pagamentos_pix": {
        "id": "69d5b2f7",
        "registro_datahora": "2019-08-30T20:49:20.000-03:00",
        "valor_pago": "",
        "autorizacao": "",
        "transacao": "",
        "retorno_codigo": "2",
        "retorno_mensagem": "Pendente",
        "rps_numero": "",
        "nfce_qrcode": "",
        "nfce_chave_acesso": "",
        "tag": "",
        "status": "2",
        "tipo": "PIX"
    }
}

EXEMPLO DE RETORNO EM CASO DE SUCESSO PARA PAGAMENTO CANCELADO (200 – OK)

{
    "pagamentos_pix": {
        "id": "69d5b2f7",
        "registro_datahora": "2019-08-30T20:49:20.000-03:00",
        "valor_pago": "",
        "autorizacao": "",
        "transacao": "",
        "retorno_codigo": "3",
        "retorno_mensagem": "Cancelado",
        "rps_numero": "",
        "nfce_qrcode": "",
        "nfce_chave_acesso": "",
        "tag": "",
        "status": "3",
        "tipo": "PIX"
    }
}

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.