Adicionando um item de recorrência:
Adicionar o item durante a criação da recorrência:
Exemplo de URL:
/v2/Orders/CardPayments/Authorize
Exemplo de Request:
{
"installments": 1,
"capture": true,
"returnUrl": "https://seusite.com",
"transactionType": "Credit",
"card": {
"number": "123456789101112",
"securityCode": "123",
"expirationDate": {
"year": "2025",
"month": "12"
},
"holder": {
"name": "string"
}
},
"saveCard": true,
"validateCard": true
},
"enableAntifraud": true,
"merchantOrderId": "orderNumber",
"customer": {
"name": "string",
"identity": "08501314577",
"identityType": "cpf",
"email": "teste@api.com",
"birthdate": "02/04/1997",
},
"amount": 1000,
"recurrence": {
"merchantPlanId": "1",
"startDate": "2023-08-16T20:00:17.709Z",
"items": [
{
"description": "Item adicional",
"amount":100
}
]
},
"callbackUrl": "https://suafuncao.com",
"clientId": "TesteDeApi"
}
Como visto acima, basta adicionar o array "items" ao objeto "recurrence" para que um item de recorrência possa ser configurado.
Todo item de recorrência irá acompanhar as datas do plano vigente. Caso o seu plano de recorrência seja configurado para uma cobrança mensal, o item acompanhará essa periodicidade.
Acrescentar descontos à fatura no formato de Item:
Além de possibilitar adicionar itens à fatura - como por exemplo produtos que não estejam dentro do plano original - os itens também permitem a adição de descontos. Para realização desta ação, basta adicionar um item normalmente e incluir o valor desejado na forma negativa (R$ -10,99 seria digitado da seguinte forma: "-1099"). Obs.: Se o desconto for maior que o valor da fatura, esta apresentará valor zerado, ou seja, não é possível haver uma fatura negativa.
Adicionar item à recorrência existente:
URL (POST):
/v2/Orders/RecurrenceItem
HEADER:
BODY
Exemplos de Body para utilização:
Body para Cobrança:
{
"merchantOrderId": "2023-11-28-1507",
"isRecurrent": true,
"quantity": 1,
"description": "Aluguel Filme 4K - Paradigma Studios",
"amount": 1499
}
Body para Desconto:
{
"merchantOrderId": "2023-11-28-1507",
"isRecurrent": true,
"quantity": 1,
"description": "Desconto no Item 1",
"amount": -1099
}