Skip to main content

Pagamento de mensalidade

Registra o pagamento de mensalidade para um credenciado, com cartão de crédito e gera Recibo Provisório de Serviço (RPS) ou NFC-e. 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/credenciados/<credenciado_id>/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
session_id Este parâmetro é necessário para que sejam localizados os dados do dispositivo no momento da análise da transação. SIM para Genpag, NÃO para as demais
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.
NÃO para Genpag, SIM para as demais
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".
NÃO para Genpag, SIM para as demais
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.
NÃO para Genpag, SIM para as demais
cartao_credito.consumidor
JSON contendo dados do portador do cartão de crédito.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.nome
Nome e sobrenome do portador, separado por espaço simples.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.cpf
CPF do cliente.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.email
Email do cliente, até 50 caracteres.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.telefone
Telefone do cliente, até 15 caracteres.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.data_nascimento
Data de nascimento do cliente no formato YYYY-MM-DD
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco
JSON contendo dados do endereço do cliente.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.logradouro
Nome do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.numero
Número do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.complemento
Complemento do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.bairro
Bairro do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.cidade
Cidade do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.uf
UF do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.cep
CEP do logradouro.
SIM para Genpag, NÃO para as demais
cartao_credito.consumidor.endereco.pais
Sigla do país do logradouro.
SIM para Genpag, NÃO para as demais
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.cpf
CPF 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
external_id
Identificador externo.
NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
credenciado_id
Código do credenciado gerado na garagem.
valor
Valor da mensalidade a ser pago.
validade_datahora
Data e hora de validade da mensalidade.
vencimento_datahora
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_numero
Número do RPS 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": "123456",
        "valor": 100.5,
        "validade_datahora": "2021-08-20T23:59:59-03:00",
        "vencimento_datahora": "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": "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 credenciado 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