Venda de diária
Registra na garagem a venda de um plano de diárias, com cartão de crédito e gera Recibo Provisório de Serviço (RPS) ou NFC-e. O código da diária é passado como parâmetro na URL do serviço. Ele deve estar cadastrado previamente na garagem. As regras de cálculo de vigência e valor da diária A transação financeira com a empresa adquirente do cartão de crédito segue as mesmas condições descritas no serviço PAGAMENTO DE TICKET. Caso o parâmetro rps não seja informado, o RPS é gerado sem identificação do tomador do serviço. Caso o parâmetro rps seja informado, os parâmetros para identificação do tomador são obrigatórios.
POST api/integradores/diarias/<codigo>/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 (BODY)
| CHAVE |
DESCRIÇÃO |
OBRIGATÓRIO |
|
cliente_nome
|
Nome do cliente, até 50 caracteres.
|
SIM |
|
cliente_documento
|
Documento do cliente, até 12 caracteres.
|
NÃO
|
|
cliente_cpf
|
CPF do cliente.
|
NÃO |
|
cliente_telefone
|
Telefone do cliente, até 15 caracteres.
|
NÃO |
|
cliente_email
|
Email do cliente, até 50 caracteres.
|
NÃO |
|
veiculo_placa
|
Placa do veículo do cliente.
|
SIM |
|
vigencia_inicio_datahora
|
Data e hora do início de vigência do plano de diárias.
|
SIM |
| forma_pagamento |
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. O tipo do campo a ser enviado é um texto e não um número. |
NÃO |
|
cartao_credito.token
|
Token gerado pelo adquirente e armazenado pelo integrador, representando o cartão de crédito.
|
NÃO |
|
cartao_credito.numero
|
Número do cartão de crédito.
|
SIM |
|
cartao_credito.portador
|
Nome do portador do cartão de crédito.
|
SIM |
|
cartao_credito.validade
|
Data de validade do cartão de crédito no formato MM/YYYY.
|
SIM
|
|
cartao_credito.codigo_seguranca
|
Código de segurança do cartão de crédito.
|
SIM
|
|
cartao_credito.bandeira
|
Bandeira do cartão de crédito. Para Cielo, um valor entre "Visa", "Master", "Amex", "Elo", "Aura", "JCB", "Diners", "Discover", "Hipercard" e "Hiper". Para Getnet, um valor entre "Visa", "Mastercard", "Amex", "Elo", e "Hipercard".
|
SIM
|
|
cartao_credito.tokeniza
|
True para armazenar o cartão de crédito e gerar token para futuros pagamentos.
False para não armazenar o cartão de crédito.
|
SIM
|
|
rps
|
JSON contendo dados para emissão de RPS. Caso não seja fornecido, será gerado RPS na garagem sem identificação do tomador do serviço.
|
NÃO
|
|
rps.pessoa_fisica
|
JSON contendo dados da pessoa física tomadora do serviço.
|
SIM
|
|
rps.pessoa_fisica.email
|
E-mail do tomador do serviço.
|
SIM
|
|
rps.pessoa_fisica.cpf
|
CPF do tomador de serviço.
|
SIM
|
|
rps.pessoa_fisica.nome
|
Nome do tomador de serviço.
|
SIM
|
|
rps.pessoa_fisica.logradouro
|
JSON contendo dados do endereço do tomador do serviço.
|
SIM
|
|
rps.pessoa_fisica.logradouro.tipo
|
Tipo do logradouro. Um valor dentre “RUA”, “AV” e “ROD”.
|
SIM
|
|
rps.pessoa_fisica.logradouro.nome
|
Nome do logradouro.
|
SIM
|
|
rps.pessoa_fisica.logradouro.numero
|
Número do logradouro.
|
SIM
|
|
rps.pessoa_fisica.logradouro.complemento
|
Complemento do logradouro.
|
SIM
|
|
rps.pessoa_fisica.logradouro.bairro
|
Bairro do logradouro.
|
SIM
|
|
rps.pessoa_fisica.logradouro.cidade
|
Cidade do logradouro.
|
SIM
|
|
rps.pessoa_fisica.logradouro.uf
|
UF do logradouro.
|
SIM
|
|
rps.pessoa_fisica.logradouro.cep
|
CEP do logradouro.
|
SIM
|
|
rps.pessoa_juridica
|
JSON contendo dados da pessoa jurídica tomadora do serviço.
|
SIM
|
|
rps.pessoa_juridica.email
|
E-mail do tomador do serviço.
|
SIM
|
|
rps.pessoa_juridica.cnpj
|
CNPJ do tomador de serviço.
|
SIM
|
|
rps.pessoa_juridica.nome
|
Nome do tomador de serviço.
|
SIM
|
|
rps.pessoa_juridica.logradouro
|
JSON contendo dados do endereço do tomador do serviço.
|
SIM
|
|
rps.pessoa_juridica.logradouro.tipo
|
Tipo do logradouro. Um valor dentre “RUA”, “AV” e “ROD”.
|
SIM
|
|
rps.pessoa_juridica.logradouro.nome
|
Nome do logradouro.
|
SIM
|
|
rps.pessoa_juridica.logradouro.numero
|
Número do logradouro.
|
SIM
|
|
rps.pessoa_juridica.logradouro.complemento
|
Complemento do logradouro.
|
SIM
|
|
rps.pessoa_juridica.logradouro.bairro
|
Bairro do logradouro.
|
SIM
|
|
rps.pessoa_juridica.logradouro.cidade
|
Cidade do logradouro.
|
SIM
|
|
rps.pessoa_juridica.logradouro.uf
|
UF do logradouro.
|
SIM
|
|
rps.pessoa_juridica.logradouro.cep
|
CEP do logradouro.
|
SIM
|
RETORNO EM CASO DE SUCESSO (200 – OK)
| CHAVE |
DESCRIÇÃO |
|
cliente_codigo |
Código do cliente gerado na garagem. |
|
codigo_barras_numero |
Número do código de barras gerado na garagem que deve ser utilizado pelo cliente para entrar e sair do estacionamento. O mesmo código deve ser utilizado nos caixas assistidos e nos caixas de autopagamento caso o cliente exceda a validade da diária. |
|
codigo_barras_tipo |
Tipo do código de barras que deve ser gerado no aplicativo do cliente. Um valor entre "ITF" e "EAN13". |
|
vigencia_inicio_datahora |
Data e hora do início de vigência do plano de diárias. |
|
validade_datahora |
Data e hora de validade da diária. |
|
valor |
Valor da diária a ser 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. |
|
cartao_credito_token |
Token do cartão de crédito para futuros pagamentos. O token não fica armazenado na API e não pode ser consultado novamente. |
|
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. |
EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)
{
"diaria_pagamento": {
"cliente_codigo": "123456",
"codigo_barras_numero": "12345678",
"codigo_barras_tipo": "ITF",
"vigencia_inicio_datahora": "2021-08-20T00:00:00-03:00",
"validade_datahora": "2021-08-21T00:00:00-03:00",
"valor": "50.5",
"autorizacao": "12345678",
"transacao": "1234567890",
"retorno_codigo": "4",
"retorno_mensagem": "Operation Successful"
"cartao_credito_token": "db62dc71-d07b-4745-9969-42697b988ccb",
"rps_numero": "000000123456",
"nfce_qrcode": "http://dec.fazenda.uf.gov.br/ConsultarNFCe.aspx?p=5019131613336820762580901",
"nfce_chave_acesso": "38010022300500997503763196132135776124080302",
}
}OUTROS RETORNOS
| CÓDIGO HTTP |
DESCRIÇÃO |
| 401 |
Caso as credenciais sejam inválidas. |
|
404 |
Caso o código da diária não seja encontrado na garagem. |
| 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 realizar comunicação com a automação da garagem. |
EXEMPLO DE RETORNO EM CASO DE ERRO (422 – UNPROCESSABLE ENTITY)
{
"error": {
"retorno_codigo": "05",
"retorno_mensagem": "Operação não autorizada"
}
}