Skip to main content

Pagamento de contrato de plano

Registra o pagamento de mensalidadecontrato parade um credenciado,plano, com cartão de crédito e gera Reciboum Provisóriodocumento de Serviço (RPS) ou NFC-e.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 TICKETESTADIA. Caso o parâmetro rpsdocumento fiscal não seja informado, o RPSdocumento fiscal é gerado sem identificação do  tomador do serviço. Caso o parâmetro rpsdocumento fiscal seja informado, os parâmetros para identificação do tomador são obrigatórios.

POST api/integradores/credenciados/<credenciado_id>/pagamentosplanos_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
forma_pagamento
plano_contrato_id		Código do contrato de plano a ser pagoSIM
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. 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. NÃO para Genpag, SIM para as demais
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_fiscalnomedocumento_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
credenciado_idid
Código do credenciadofaturamento geradode nacontrato garagem.de plano.
plano_contrato_id
Código do contrato de plano
valor
Valor da mensalidade a ser pago.
validade_datahoravalido_ate
Data e hora de validade da mensalidade.
vencimento_datahoravalido_de

vencimento
Data e hora do próximo vencimento da mensalidade.
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_numerodocumento_fiscal_numero
Número do RPSdocumento fiscal gerado na garagem.
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)

{
    "credenciado_pagamento": {
        "credenciado_id"id": "123456",
        "plano_contrato_id": "123456",
        "valor": 100.5,
        "validade_datahora"valido_ate": "2021-08-20T23:59:59-03:00",
        "vencimento_datahora"valido_de": "2021-08-20T23:59:59-03:00",
        "vencimento": "2021-08-20T23:59:59-03:00",
        "autorizacao": "12345678",
        "transacao": "1234567890",
        "retorno_codigo": "4",
        "retorno_mensagem": "Operation Successful"
        "cartao_credito_token": "db62dc71-d07b-4745-9969-42697b988ccb",
        "rps_numero"documento_fiscal_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 do credenciadoplano 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