Recorrência
Planos
Criando uma Assinatura
O processo de criação de uma assinatura está vinculado à criação da primeira cobrança.
O corpo da solicitação consiste em 3 parâmetros e dois objetos aninhados, delineados abaixo:
- key: Chave gerada no Sistema Bass Pago.
- externalId: Número de referência ou identificador único da assinatura. Este número deve ser exclusivo para a respectiva chave.
- externalProductId: Número de identificação do serviço e/ou produto no sistema externo.
- externalProductName: Nome do serviço e/ou produto no sistema externo.
- solicitacao: Mensagem de texto para ser mostrada ao cliente.
Objeto devedor*:
- devedorCep*: CEP do endereço do devedor. Deve conter apenas 8 dígitos.
- devedorEndereco*: Endereço do devedor, incluindo rua e número.
- devedorBairro*: Bairro do endereço do devedor.
- devedorCidade*: Cidade do endereço do devedor.
- devedorUf*: Estado (UF) do endereço do devedor. Deve conter apenas 2 letras.
- devedorDdd: DDD do telefone do devedor.
- devedorTelefone: Número de telefone do devedor.
- devedorMail: E-mail do usuário que efetua o pagamento. Por meio desse e-mail, o devedor receberá notificações sobre a conclusão do pagamento. (IMPORTANTE: Este parâmetro é opcional. Se fornecido, o Sistema Bass Pago enviará notificações por e-mail ao devedor, informando sobre a nova cobrança criada em seu nome, além de lembretes antes do vencimento da cobrança.)
- devedorNome*: Nome completo do devedor.
- devedorInscricaoNacional*: CPF ou CNPJ do devedor. Só dígitos. [CPF: 11 dígitos, CNPJ: 14 dígitos].
Objeto plan:
- referenceNumber: Caso seja um Plano pré-definido, basta enviar o referenceNumber retornado na criação do plano. No caso de Plano por assinatura, enviar null.
- externalId: Identificador do Plano dado pelo cliente.
- name: Nome do Plano. Pode ser mostrado para o cliente na página de pagamento.
- description: Descrição do produto e/ou serviço apresentados no Plano. Pode ser mostrado para o cliente na página de pagamento.
- amount: Valor do plano. Esse mesmo valor será cobrado em cada parcela
- trialDays: Dias de teste do produto e/ou serviço. Antes de fazer o primeiro pagamento
- installments: Número total de parcelas
- attempts: Tentativas de cobranças de uma parcela. No caso do CARD, caso o cartão esteja bloqueado ou sem saldo, após completar o número total de tentativas, a assinatura é cancelada.
- type: Tempo entre as cobranças.[MONTHLY, BIMONTHLY, QUARTERLY, SEMESTERLY, YEARLY, CUSTOM]
- interval: Se o type for "CUSTOM", será definido em dias.
Caso não seja um Plano pré-definido, o restante dos campos do objeto Plan devem ser enviados.
A resposta:
Na resposta:
- token: Identificador público único para a cobrança gerado pelo Sistema Bass Pago. É necessário para criar a URL da página de pagamento.
- referenceNumber: Identificador único para a cobrança gerado Sistema Bass Pago.
- planReferenceNumber: Identificador único do Plano associado à cobrança.
- subscriptionReferenceNumber: Identificador único para a assinatura gerado Sistema Bass Pago.
Neste cenário, o Sistema Bass Pago assume a responsabilidade de proporcionar a interface de usuário durante o processo de pagamento. Acessar no menú da documentação Paycheckout > Checkout por API. Depois Checkout por URL
Consultar lista de Assinaturas
É possível Consultar lista de Assinaturas criadas por chave.
A resposta:
Na resposta:
- referenceNumber: Identificador único para a assinatura gerado Sistema Bass Pago.
- status: Status da assinatura.
Estados de uma assinatura:
- CREATED: A assinatura e a primeira cobrança foram criadas. O cliente tem 20 minutos para inserir os dados de pagamento.
- REJECTED: O cliente não completou as informações de pagamento ou foi rejeitado.
- PENDING: Os dados de pagamento foram validados e configurado "trialsDays" na assinatura. Até a conclusão dos dias de prova e a primeira cobrança ser feita.
- ACTIVE: As cobranças estão sendo realizadas corretamente.
- CANCELLED: A assinatura é cancelada via API ou sistema.
- CANCELLED_BY_ATTEMPTS: Ao tentar executar uma cobrança, todas as tentativas definidas no campo “tentativas” são consumidas (as tentativas são feitas uma vez por dia).
- CLOSED: Todas as cobranças definidas no campo “installments” foram realizadas corretamente
No header da resposta, tem o campo X-Total-Count, que retorna o valor total dos elementos na consulta. O que permite percorrer a paginação, até o último elemento
Aplicando paginação e filtros à consulta
Quando a quantidade dos Planos em uma consulta é muito grande, o ideal é paginar a resposta. Isso evita sobrecarga de memória e também resposta lenta. O número máximo de elementos por página no sistema é 50 (o padrão é 10 elementos).
Paginar a resposta:
Campos do paginado:
- page: Aponte para a página onde a solicitação está sendo feita. A primeira página está sempre no valor 0.
- size: Número de elementos que a consulta retornará.
Filtros:
É possível aplicar filtros à consulta, bem como ordená-la
Ordenar:
- sort: É possível ordenar por campo, Crescente (Asc) ou Decrescente (Desc)
Filtrar:
- createdAt: Data de criação do Checkout
- updatedAt: Data da última atualização de Checkout
Para mais opções de gerenciamento de filtros, recomendamos consultar a documentação a seguir: https://www.jhipster.tech/entities-filtering/
Obter detalhe de uma Assinatura
É possível Consultar o detalhe de uma Assinatura pelo referenceNumber no parámetro da URL.
A resposta:
Cancelar uma Assinatura
Ao cancelar uma Assinatura, caso haja alguma cobrança pendente, a mesma também será cancelada. Bem como o restante das futuras parcelas dessa assinatura.
A resposta: