| 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 |
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
--request PUT "https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
16
--verbose
A seguir, veja as propriedades de campo nesta requisição:
| Propriedade (header) | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
MerchantId | Guid | 36 | Sim | Identificador da loja no Split de Pagamento |
MerchantKey | Texto | 40 | Sim | Chave Publica para Autenticação Dupla no Split de Pagamento |
Content-Type | Header | 40 | Sim | Application/json |
RequestId | Guid | 36 | Não | Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. |
| Propriedade (body) | Descrição | Tipo | Tamanho | Obrigatório? |
|---|---|---|---|---|
RecurrentPaymentId | Número de identificação da recorrência. | Texto | 50 | Sim (envio no endpoint) |
RecurrencyDay | Dia da recorrência. | Número | 2 | Sim |
Resposta
HTTP Status 200
Consulte a lista de códigos HTTP para ver todos os códigos de status possivelmente retornados pela API.