Skip to main content

Pagamento de estadia via PIX

Registra o pagamento de uma estadia, via PIX, libera a estadia para saída e gera documento fiscal. 


POST api/estadias_faturamentos/pix

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 (BODY)
Todos os valores devem ser enviados como strings.

CHAVE
DESCRIÇÃO
OBRIGATÓRIO
transacao_id
Identificador único e temporário da transação de consulta.
SIM
modalidade_pagamento_id
Código interno do sistema, solicitar a garagem o código a ser informado nesse, caso não seja enviado, assumiremos o valor padrão definido nas configurações do usuário.
NÃO
documento_fiscal
JSON contendo dados para emissão de documento fiscal. Caso não seja fornecido, será gerado documento fiscal na garagem sem identificação do tomador do serviço.
NÃO
documento_fiscal.nome
Nome do tomador de serviço.
SIM
documento_fiscal.documento
CPF/CNPJ do tomador de serviço.
SIM
consumidor.nome Nome do portador do cartão de crédito. SIM
consumidor.documento
Data de validade do cartão de crédito no formato MM/YYYY.
SIM
tag
Identificador do integrador, utilizado como marcador para consultas futuras. (no máximo 20 caracteres)
NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
DESCRIÇÃO
id
Identificador único da transação do pix. Código que a ser usado na consulta para saber o status do pagamento no endpoint de Consulta pagamento via pix por ID.
localizador
Localizador da estadia.
valor_pago
Valor pago pela estadia.
tag
Identificador do integrador.
qrcode_pix
Código do QRCode do pix para efetuar o pagamento.
status
0 (pendente) e 1 (pago)

RETORNO EM CASO DE SUCESSO DE PAGAMENTO 

{
    "estadia_faturamento_pix": {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "localizador": "1234567890",
        "valor_pago": "5.0",
        "tag": "ABCDEF0123456789",
        "status": 0
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
DESCRIÇÃO
400
Caso os parâmetros passados estejam incorretos.
401
Caso as credenciais sejam inválidas.
404
Caso o identificador único da transação de consulta não seja encontrado ou tenha expirado.
422
Caso haja problema na transação com a adquirente, dois parâmetros adicionais serão retornados: retorno_codigo e retorno_mensagem, contendo o código de retorno da adquirente e uma mensagem produzida pela API referente ao código retornado pela adquirente.
502
Caso não seja possível registrar o pagamento na automação da garagem, um parâmetro adicional error será retornado com uma mensagem de erro para o usuário.

EXEMPLO DE RETORNO EM CASO DE ERRO (422 – UNPROCESSABLE ENTITY)

{
	"error": {
      	"retorno_codigo": "05",
		"retorno_mensagem": "Operação não autorizada"
	}
}

EXEMPLO DE RETORNO EM CASO DE ERRO (502 – BAD GATEWAY)

{
	"error": "Serviço indisponível no momento. Realize o pagamento nos caixas do estacionamento."
}