Criação do plano
O primeiro passo para criar adesões é criar um plano. Os parâmetros estão descritos na documentação do método. As regras funcionais sobre como utilizar os parâmetros, conforme sua necessidade de negócio, estão explicadas na Regras para criação de Planos em Especificações Funcionais.
POST https://ws.pagseguro.uol.com.br/pre-approvals/request?{{credenciais}}
O método irá retornar o código do plano criado. Usaremos este código para fazer a adesão ao plano.
Os planos criados podem ser visualizados no seu Painel.
Os planos personalizados permitem que não seja informado o campo amountPerPayment que informa o valor a ser cobrado na recorrência. Essa configuração permite que sejam realizadas chamadas de cobrança de valores variáveis.
Nos planos personalizados, a responsabilidade de fazer o pedido de cobrança é do vendedor. Caso não haja condições de adequar seu sistema para enviar a chamada ao serviço de cobrança nos momentos corretos, opte pelo plano Automático, (charge = AUTO). Para mais informações veja sobre as Regras de Planos em Especificações Funcionais.
Exemplo: Para criar um plano automático com cobranças mensais de R$ 100,00 por durante 1 ano:
{
"preApproval": {
"name": "Assinatura da Revista Fictícia",
"charge": "AUTO",
"period": "MONTHLY",
"amountPerPayment": 100.00,
"expiration": {
"value": 1,
"unit": "YEARS"
}
},
"receiver": {
"email": "[email protected]"
}
}
Exemplo: Para criar um plano pós-pago (Cobrança Manual) com cobranças semanais de R$ 10,00 a serem efetuadas toda Segunda-feira, com duração ilimitada, e taxa de adesão de R$ 50,00:
{
"preApproval": {
"name": "Acesso ao Site Fictício",
"charge": "MANUAL",
"period": "WEEKLY",
"amountPerPayment": 10.00,
"membershipFee": 50.00,
"maxAmountPerPeriod": 50.00,
"maxPaymentsPerPeriod": 5,
"dayOfWeek": "MONDAY"
},
"receiver": {
"email": "[email protected]"
}
}
Para consultar um plano, você deve fazer uma requisição seguindo os parâmetros que estão descritos na documentação do método
GET https://ws.pagseguro.uol.com.br/pre-approvals/request?{{credenciais}}
Veja abaixo o exemplo de requisição ao PagSeguro.
https://ws.pagseguro.uol.com.br/pre-approvals/request?{{credenciais}}
&startCreationDate=2018-09-24T10:47:24-03:00
&endCreationDate=2018-09-24T18:47:24
&status=ACTIVE
O parâmetro de status, pode ser visto na Tabelas de Status e Erros.
Updated over 4 years ago