Fluxo Edição/Alteração/Retentiva

Edição de Valor e Planos

É possivel editar valor de cobrança de planos já criados. Para isso utilize o método /pre-approvals/request/{{preApprovalRequestCode}}/payment .

Desconto no pagamento

É possível conceder desconto para a próxima parcela da adesão. O desconto se aplica somente à cobrança subsequente, não se aplicando às demais cobranças futuras.

Para prover um desconto à próxima cobrança de uma adesão, utilize o método /pre-approvals/{{preApprovalCode}}/discount .

O parâmetro preApprovalCode é o código da adesão obtido no método **/pre-approvals já documentado em Adesão ao plano.

A resposta deste método não possui corpo.

Mudança de meio de pagamento

Durante a vigência de uma adesão ativa é possível atualizar os dados de pagamento da adesão.

Para alterar os dados de pagamento, utilize o método /pre-approvals/{{preApprovalCode}}/payment-method .

O parâmetro preApprovalCode é o código da adesão obtido no método /pre-approvals já documentado em Adesão ao plano.

A resposta deste método não possui corpo.

Retentativa de Pagamento

Para uma Ordem de Pagamento que não tenha sido cobrada com sucesso, pode-se solicitar a retentativa de cobrança através deste serviço. Isto irá gerar uma nova transação para esta Ordem de Pagamento.

A geração da cobrança não é instantânea, a chamada ao serviço irá colocar a ordem de pagamento em uma fila de retentativas.

Para solicitar a retentativa de cobrança, utilize o método /pre-approvals/{{preApprovalCode}}/payment-orders/{{paymentOrderCode}}/payment.

O parâmetro {preApprovalCode} é o código da adesão obtido no método /pre-approvals já documentado em Adesão ao plano.

O parâmetro {paymentOrderCode} é o código da ordem de pagamento a ser retentada. É obtido no método já documentado em Listar ordens de pagamento.

Para uma ordem ser retentada, ela precisa estar com status "Não pago" (status 6). Veja na Tabelas de Status e Erros todos os status de uma ordem de pagamento.

O método retorna o código da nova transação.