Confira a seguir os recursos disponíveis na API E-commerce Cielo.
API transacional
URL sandbox: https://apisandbox.cieloecommerce.cielo.com.br
URL produção: https://api.cieloecommerce.cielo.com.br
| Método | Endpoint | Descrição |
|---|---|---|
get | /1/cardBin/{BIN} | Consulta o BIN do cartão. |
post | /1/zeroauth/ | Faz a validação Zero Auth do cartão. |
post | /1/sales | Cria pagamentos (para cada meio de pagamento), cria pagamentos com cartões tokenizados e recorrências. |
put | /{paymentId}/capture?amount={Valor} | Captura transação de cartão de crédito. |
put | /1/sales/{PaymentId}/void?amount={Valor} | - Cancela transação de cartão de crédito ou débito via PaymentId;- Solicita uma devolução Pix. |
put | /1/sales/OrderId/{MerchantOrderId}/void?amount={Valor} | Cancela transação de cartão de crédito ou débito via MerchantOrderId. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Customer | Altera dados do comprador em um pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Payment | Altera dados do pagamento recorrente. |
put | RecurrentPayment/{RecurrentPaymentId}/Amount | Altera valor do pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay | Altera dia do pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate | Altera data do próximo pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Interval | Altera intervalo do pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/EndDate | Altera data final do pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Deactivate | Desativa um pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Reactivate | Reativa um pagamento recorrente. |
API de consulta
URL sandbox: https://apiquerysandbox.cieloecommerce.cielo.com.br
URL produção: https://apiquery.cieloecommerce.cielo.com.br
| Método | Endpoint | Descrição |
|---|---|---|
get | /1/sales/{PaymentId} | Consulta transação pelo PaymentId. |
get | /1/sales/acquirerTid/{TID} | Consulta transação pelo Tid. |
get | /1/sales?merchantOrderId={merchantOrderId} | Consulta transação pelo MerchantOrderId. |
get | /1/RecurrentPayment/{RecurrentPaymentId} | Consulta transação recorrente. |