Faturamento de contrato de plano

Fatura contrato de plano, com cartão de crédito e gera um documento fiscal. 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 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.

POST api/planos_contratos_faturamentos

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_id	Código do contrato de plano a ser pago	SIM
modalidade_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
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
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
tag_externa	Identificador do integrador.	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.
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.serie_contador	Número do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
documento_fiscal.serie_codigo	Código do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
modalidades	Lista das modalidades utilizadas no faturamento.
modalidades[].id	Código da modalidade de pagamento.
modalidades[].identificacao	Identificação da modalidade de pagamento.
modalidades[].valor	Valor pago através da modalidade de pagamento.
tag_externa	Identificador do integrador.

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

{
    "planos_contratos_faturamentos": [
      {
        "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",
        "cartao_credito_token": "db62dc71-d07b-4745-9969-42697b988ccb",
        "documento_fiscal_numero": "123456",
        "modalidades": [
          {
            "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
            "identificacao": "DÉBITO",
            "valor": 100.5
          }
        ]
      }
    ]
}

OUTROS RETORNOS

CÓDIGO HTTP	DESCRIÇÃO
401	Caso as credenciais sejam inválidas.
404	Caso o código do plano 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"
  	}
}