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.

Autorização Zero Dólar

A funcionalidade de Autorização Zero Dólar permite que você valide o cartão de crédito fornecido pelo seu cliente antes de cadastrar o assinante e gerar um token PagBank.

Para realizar a validação do cartão, você precisa fornecer o CVV (Security code) juntamente com os demais dados do cartão (PAN, data de expiração, nome do portador do cartão) no momento da criação do assinante utilizando o endpoint Criar Assinante. Essa operação pode ser realizada com ou sem uma assinatura, tanto nos casos de cartões criptografados quanto nos casos de cartões abertos.

📘

A autorização é obrigatória quando o integrador não possuir certificação PCI.

A validação utilizando a Autorização Zero Dólar é feita sem sensibilizar o valor na fatura do assinante. Essa validação está disponível apenas para as seguintes bandeiras:

• Mastercard
• Visa
• Elo
• Hipercard
• Hiper

Caso o cartão utilizado para realizar um pagamento não seja de uma das bandeiras disponíveis, não haverá tentativa de validação através da Autorização Zero Dólar, e um token PagBank será gerado.

Caso o cartão utilizado passe pela Autorização Zero Dólar e não seja válido, um erro com os detalhes sobre a validação será retornado pelo endpoint Criar Assinante. Consequentemente, o assinante não será criado. Para mais detalhes sobre os possíveis erros, accesse a página a seção Lista de erros do endpoint validar e armazenar cartão.