Ao efetuar a alteração do dia da recorrência, considere as seguintes regras para execução da atualização na API:
- Se o novo dia informado for depois do dia atual, iremos atualizar o dia da recorrência com efeito na próxima recorrência.
Exemplo: hoje é dia 05/05 e a próxima recorrência é dia 25/05. Quando atualizado para o dia 10, a data da próxima recorrência será dia 10/05.
- Se o novo dia informado for antes do dia atual, iremos atualizar o dia da recorrência, mas este só terá efeito depois que a próxima recorrência for executada com sucesso.
Exemplo: hoje é dia 05/05 e a próxima recorrência é dia 25/05. Quando atualizado para o dia 03, a data da próxima recorrência permanecerá dia 25/05. Após sua execução, a recorrência seguinte será agendada para o dia 03/06.
- Se o novo dia informado for antes do dia atual, mas a próxima recorrência for em outro mês, iremos atualizar o dia da recorrência com efeito na próxima recorrência.
Exemplo: hoje é dia 05/05 e a próxima recorrência é dia 25/09. Quando atualizado para o dia 03, a data da próxima recorrência será 03/09.
Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay |
| Produção | put | https://api.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay |
--header "Authorization: Bearer {access_token}"
--request PUT "https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay"
--header "Content-Type: application/json"
--header 'Bearer: {access_token}'
--data-binary
16
--verboseParâmetros do header
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization Bearer: access_token | String | -- | Sim | Token de acesso. Informe o access_token obtido para a autenticação OAuth2 |
Parâmetros do path
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório? |
|---|---|---|---|---|
RecurrentPaymentId | Número de identificação da recorrência. | Texto | 50 | Sim (envio no endpoint) |
Parâmetros do query
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório? |
|---|---|---|---|---|
RecurrencyDay | Dia da recorrência. | Número | 2 | Sim |
Resposta
HTTP Status 200Consulte a lista de códigos HTTP para ver todos os códigos de status possivelmente retornados pela API.