Skip to main content

Consulta faturamento de contrato de plano

RegistraConsulta o pagamentofaturamento de contrato de plano,plano com cartão de crédito e gera um documento fiscal. A transação financeira com a empresa adquirenteatravés do cartão de crédito segue as mesmas condições descritas no serviço PAGAMENTO DE ESTADIA. Caso o parâmetro documento fiscal não seja informado, o documento fiscal é gerado sem identificação do  tomador do serviço. Caso o parâmetro documento fiscal seja informado, os parâmetros para identificação do tomador são obrigatórios.plano_contrato_faturamento_id

POSTGET api/planos_contratos_faturamentosplanos_contratos_faturamentos/<plano_contrato_faturamento_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 (BODY)

CHAVE
DESCRIÇÃO
OBRIGATÓRIO
plano_contrato_idCódigo do contrato de plano a ser pagoSIM
modalidade_idCó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
cartao_credito.tokenToken gerado pelo adquirente e armazenado pelo integrador, representando o cartão de crédito.NÃO
cartao_credito.numeroNúmero do cartão de crédito.SIM
cartao_credito.portadorNome 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
documento_fiscal
JSON contendo dados da pessoa jurídica tomadora do serviço.
SIM
documento_fiscal.documento
CPF do tomador de serviço.
SIM
documento_fiscal.nome
Nome do tomador de serviço.
NÃO
external_id
Identificador externo.
NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
id
Código do faturamento de contrato de plano.
plano_contrato_id
Código do contrato de plano
valor
Valor pago.
registrado_em
Data e hora do registro de pagamento.
valido_de
Data e hora do início da validade
valido_ate
Data e hora do fim da validade.
vencimento
Data e hora do próximo vencimento.
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.
documento_fiscal_numero
Número do documento fiscal gerado na garagem.

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

{
    "plano_contrato_faturamento": {
        "id": "ebc471e3-aed6-47d7-a76c-758c335deb05",
        "plano_contrato_id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "valor": 100.5,
        "registrado_em": "2019-08-30T18:35:25.000-03:00",
        "valido_de": "2019-08-30T18:35:25.000-03:00",
        "valido_ate": "2019-09-30T18:35:25.000-03:00",
        "vencimento": "2019-08-30T18:35:25.000-03:00",
        "autorizacao": "12345678",
        "transacao": "1234567890",
        "retorno_codigo": "4",
        "retorno_mensagem": "Operation Successful"
        "cartao_credito_token": "db62dc71-d07b-4745-9969-42697b988ccb",
        "documento_fiscal_numero": "123456"
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
401
Caso as credenciais sejam inválidas.
404
Caso o código do planofaturamento deplano contrato 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 SUCESSO (200 – OK)

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

Back to top