get
https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/
Consulta uma transação recorrente informando o RecurrentPaymentId
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | get | https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId} |
| Produção | get | https://apiquery.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId} |
Saiba mais sobre essa funcionalidade na documentação.
Apenas as transações dentro dos últimos três meses podem ser consultadas via API.
- O
RecurrentPaymentIdé a identificação do pedido recorrente retornado na criação do pagamento com recorrência; - A consulta por
RecurrentPaymentIdirá retornar todos os detalhes da transação recorrente.
Resposta da consulta de pedido recorrente
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na consulta de um pedido recorrente.
| Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
Installments | Número de parcelas. | intenger | 2 |
RecurrentPaymentId | ID que representa a recorrência, utilizada para consultas e alterações futuras. | string | 36 |
NextRecurrency | Data de quando acontecerá a próxima recorrência. | string | 10 |
StartDate | Data para início da recorrência. | string | 10 |
EndDate | Data do fim da recorrência. | string | 10 |
Interval | Intervalo entre as recorrências. | string | 10 |
CurrentRecurrencyTry | Número atual da tentativa de recorrência. | integer | 1 |
RecurrencyDay | Dia da recorrência. | integer | 2 |
SuccessfulRecurrences | Quantidade de recorrências realizadas com sucesso. | integer | 2 |