Lista de recursos

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

/1/cardBin/{BIN}

Consulta o BIN do cartão.

/1/zeroauth/

Faz a validação Zero Auth do cartão.

/1/sales

Cria

pagamentos

(para cada meio de pagamento), cria pagamentos com

cartões tokenizados

e

recorrências

.

/{paymentId}/capture?amount={Valor}

Captura transação de cartão de crédito.

/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.

/1/sales/OrderId/{MerchantOrderId}/void?amount={Valor}

Cancela transação de cartão de crédito ou débito via

MerchantOrderId

.

/1/RecurrentPayment/{RecurrentPaymentId}/Customer

Altera dados do comprador em um pagamento recorrente.

/1/RecurrentPayment/{RecurrentPaymentId}/Payment

Altera dados do pagamento recorrente.

RecurrentPayment/{RecurrentPaymentId}/Amount

Altera valor do pagamento recorrente.

/1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay

Altera dia do pagamento recorrente.

/1/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate

Altera data do próximo pagamento recorrente.

/1/RecurrentPayment/{RecurrentPaymentId}/Interval

Altera intervalo do pagamento recorrente.

/1/RecurrentPayment/{RecurrentPaymentId}/EndDate

Altera data final do pagamento recorrente.

/1/RecurrentPayment/{RecurrentPaymentId}/Deactivate

Desativa um pagamento recorrente.

/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

/1/sales/{PaymentId}

Consulta transação pelo

PaymentId

.

/1/sales/acquirerTid/{TID}

Consulta transação pelo

Tid

.

/1/sales?merchantOrderId={merchantOrderId}

Consulta transação pelo

MerchantOrderId

.

/1/RecurrentPayment/{RecurrentPaymentId}

Consulta transação recorrente.