Check out the available resources in the Cielo E-commerce API below
Transactional API
URL sandbox: https://apisandbox.cieloecommerce.cielo.com.br
URL production: https://api.cieloecommerce.cielo.com.br/
| Method | Endpoint | Description |
|---|---|---|
get | 1/cardBin/{BIN} | Query the card BIN. |
post | 1/zeroauth/ | Performs Zero Auth card validation. |
post | /1/sales | Creates payments (for each payment method, creates payments with tokenized cards and recurrences). |
put | {paymentId}/capture?amount={Valor}&serviceTaxAmount={Valor}" | Captures credit card transaction. |
put | 1/sales/{PaymentId}/void?amount=xxx | Cancels credit transaction via PaymentId. |
put | 1/sales/OrderId/{MerchantOrderId}/void?amount=xxx | Cancels credit transaction via MerchantOrderId. |
put | 1/RecurrentPayment/{RecurrentPaymentId}/Customer | Requests a Pix refund. |
put | 1/RecurrentPayment/{RecurrentPaymentId}/Payment | Changes shopper's data in a recurring payment. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Payment | Changes recurring payment data. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay | Changes recurring payment day. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate | Changes next recurring payment date. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Interval | Changes recurring payment interval. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/EndDate | Changes end date of recurring payment. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Deactivate | Deactivates a recurring payment. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Reactivate | Reactivates a recurring payment. |
Query API
URL sandbox: https://apiquerysandbox.cieloecommerce.cielo.com.br
URL production: https://apiquery.cieloecommerce.cielo.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
get | /1/sales/{PaymentId} | Queries transaction by PaymentId. |
get | /1/sales/acquirerTid/{TID} | Queries transaction by TId. |
get | /1/sales?merchantOrderId={merchantOrderId} | Queries transaction by MerchantOrderId. |
get | /1/RecurrentPayment/{RecurrentPaymentId} | Queries recurring transaction. |