Assinantes

Para iniciar uma assinatura, é necessário cadastrar um assinante com os dados de pagamento. Essa ação pode ser realizada tanto por meio desta API quanto no momento da criação da assinatura. A API de assinantes também possibilita que você realize a validação de cartões utilizando a funcionalidade Autorização Zero Dólar.

Endpoints

A API de assinaturas do PagBank disponibiliza os seguintes endpoints para simplificar o gerenciamento dos seus assinantes:

Criar Assinante: Registre um novo assinante, fornecendo os dados essenciais, incluindo informações de pagamento.
Consultar por ID: Obtenha detalhes específicos de um assinante usando seu identificador único.
Listar Assinantes:: Visualize a lista completa de todos os assinantes registrados em sua conta.
Alterar Dados Cadastrais do Assinante: Faça edições nos dados pessoais de um assinante para manter as informações atualizadas.
Alterar Dados de Pagamento do Assinante: Atualize as informações de pagamento de um assinante, garantindo precisão e continuidade nas transações.

Objeto Assinante

A API de Assinaturas utiliza o objeto Assinante. Para identificar todos os parâmetros, seus respectivos tipos e exemplos de cada parâmetro do objeto, acesse Objeto Assinante.

Validação do cartão junto a bandeira

Você pode validar os cartões de crédito fornecidos pelos assinantes diretamente com as bandeiras de cartão sem gerar cobrança na fatura. Isso garante que os cartões são válidos e podem ser utilizados em cobranças futuras, mesmo que o cartão seja substituído por motivo de vencimento ou outro fator, sem necessidade de atualização manual. Essa validação está disponível para as seguintes bandeiras:

Mastercard
Visa
Hipercard
Hiper
Elo

Para utilizar essa funcionalidade, você pode utilizar uma das opções a seguir:

Crie o assinante e a assinatura em um único passo utilizando o endpoint Criar assinatura. Com essa opção, você pode cadastrar o assinante no momento de criação da assinatura passando as informações através do objeto customer.
Fornecendo CVV: Crie um assinante informando o CVV do cartão (security_code) utilizando o endpoint Criar um assinante. Na sequência, com os dados do assinante criado, Crie uma assinatura.
Sem envio do CVV: Crie um assinante sem informar o CVV do cartão utilizando o endpoint Criar um assinante. Na sequência, com os dados do assinante criado, Crie uma assinatura. Nesse caso, o PagBank realiza a tokenização do cartão, mas não realiza a validação junto a bandeira do cartão.

Dependendo dos dados fornecidos ao realizar um desses processos, você pode se deparar com um dos seguintes problemas:

Se o cartão for inválido, o endpoint retornará um erro detalhado o problema, impedindo a criação do assinante ou da assinatura.
Se o cartão pertencer a uma bandeiras não suportada, o assinante será criado, mas as cobranças não serão processadas e a assinatura não será ativada.

📘
A validação do cartão junto à bandeira é obrigatória para integradores que não possuem certificação PCI.