get
https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/
Query a recurring transaction by providing the RecurrentPaymentId.
| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | get | https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId} |
| Production | get | https://apiquery.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId} |
Recurring order query response
The table below presents the main parameters that can be returned by the API when querying a recurring order.
| Property | Description | Type | Length |
|---|---|---|---|
Installments | Number of installments. | integer | 2 |
RecurrentPaymentId | ID representing the recurrence, used for future queries and changes. | string | 36 |
NextRecurrency | Date when the next recurrence will occur. | string | 10 |
StartDate | Date when the recurrence starts. | string | 10 |
EndDate | Date when the recurrence ends. | string | 10 |
Interval | Interval between recurrences. | string | 10 |
CurrentRecurrencyTry | Current recurrence attempt number. | integer | 1 |
RecurrencyDay | Recurrence day. | integer | 2 |
SuccessfulRecurrences | Number of successful recurrences. | integer | 2 |
Only transactions within the last three months can be queried via API.