1. Recorrência
Api Expert
  • Documentos
    • Rakim Expert
    • Homologação
      • Processo de Homologação
    • Autenticação na API
    • Pagamentos
      • Introdução
      • Fingerprint
      • Criando um Pagamento
        • sales
      • Criando Pagamento com Split
        • sales/splits
      • Capturando um Pagamento Pré-Autorizado
        • capture
      • Cancelando um Pagamento
        • cancel
      • Consultando informações do Pagamento
        • consulta
      • Ativando um Split Tardio
        • Split tardio
      • Como Criar um Cofre de Cartão
        • vault
      • Inativar cofre de cartão
        • inativar vault
      • Listar os Cartões do Cofre
        • Lista vault
      • Consultando as Taxas da Transação
        • Consultar taxas
      • Listar Pagamentos
        • Listar pagamentos
      • Cartões de Teste
      • Códigos de Retorno
      • Casos de Uso
    • PIX
      • Introdução
      • Criar Cobrança Pix
        • Cobranca pix
      • Consultar Cobrança Pix
        • Cobranca pix
      • Devolução de Pagamento Pix
        • Devolução pix
    • Link de Pagamento
      • Introdução
      • Criar Link de Pagamento
        • Criar Link de Pagamento
      • Upload do Logo para Link de Pagamento
        • Upload logo
    • Recorrência
      • Introdução
      • Criar Recorrência
        • Criar Recorrência
      • Criar Link de Recorrência
        • Criar link
    • Estabelecimentos
      • Introdução
      • Criar Estabelecimento
        • Criar Estabelecimento
      • Upload de documentos
        • Upload de Documentos
      • Buscar Estabelecimento
        • Busca estabelecimento
      • Listar CNAE's
        • Listar CNAE's
      • Listar Bancos
        • Listar Bancos
      • Casos de Uso
    • Liquidações
      • Saque
        • Solicitar Saque
      • Saldo
        • Consultar Saldo
      • Extrato
        • Busca extrato
      • Extrato Analítico
        • Busca extrato
      • Extrato Futuro
        • Busca extrato
    • Antecipações
      • Introdução
      • Atualizar Antecipação Automática
        • Atualização Antecipação
      • Listar Antecipações Disponíveis
        • Listar Antecipações
      • Solicitar Antecipação
        • Solicitar Antecipação
    • Webhook's
      • Cadastrar Webhook
        • Cadastrar Webhook
      • Reenvio de Webhook de Pagamento
        • Reenvio de Webhook de Pagamento
      • Reenvio de Webhook de Estabelecimento
        • Reenvio de Webhook de Estabelecimento
      • Exemplo de Webhook
    • Status
      • Status de Pagamento
  1. Recorrência

Criar Recorrência

Parâmetros do Objeto#

Geral#

NomeTipoDescriçãoObrigatórioDefault
amountint32Valor do pagamento em centavos sem vírgula e ponto.Sim-
order_idstringID identificador do número do pedido.Não-
typeChargeint32Tipo de recorrência relacionada. Valores possíveis:
1 - Cobrar para sempre
2 - Cobrar até uma data
3 - Cobrar Nº parcelas
Sim-
totalChargesint32Número de cobranças a realizar. Obrigatório quando o tipo de recorrência enviado for cobrança por Nº parcelas.Não-
finalDatedateData do último pagamento a ser realizado. Obrigatório quando o tipo de recorrência for até uma data.Não-
paymentPaymentInformações do pagamento de recorrência.Sim-
customerCustomerInformações do participante da recorrência.Sim-

Payment#

NomeTipoDescriçãoObrigatórioDefault
typestringMétodo de pagamento. Valores possíveis: credit.Sim-
softdescriptorstringTexto exibido na fatura do cartão do comprador.Não-
currency_codestringMoeda na qual o pagamento será realizado. Valores possíveis: BRL.NãoBRL

Customer#

NomeTipoDescriçãoObrigatórioDefault
namestringNome do cliente participante da recorrência.Sim-
documentstringNúmero de documento do participante.Não-
emailstringEmail do participante.Não-
phonestringCelular do participante.Não-
birthdatedateData de nascimento do participante.Não-
Modificado em 2026-02-26 14:57:06
Página anterior
Introdução
Próxima página
Criar Recorrência
Built with