Resource List

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

1/cardBin/{BIN}

Query the card BIN.

1/zeroauth/

Performs Zero Auth card validation.

/1/sales

Creates payments (for each payment method, creates payments with tokenized cards and recurrences).

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

Captures credit card transaction.

1/sales/{PaymentId}/void?amount=xxx

Cancels credit transaction via

PaymentId

.

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

Cancels credit transaction via

MerchantOrderId

.

1/RecurrentPayment/{RecurrentPaymentId}/Customer

Requests a Pix refund.

1/RecurrentPayment/{RecurrentPaymentId}/Payment

Changes shopper's data in a recurring payment.

/1/RecurrentPayment/{RecurrentPaymentId}/Payment

Changes recurring payment data.

/1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay

Changes recurring payment day.

/1/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate

Changes next recurring payment date.

/1/RecurrentPayment/{RecurrentPaymentId}/Interval

Changes recurring payment interval.

/1/RecurrentPayment/{RecurrentPaymentId}/EndDate

Changes end date of recurring payment.

/1/RecurrentPayment/{RecurrentPaymentId}/Deactivate

Deactivates a recurring payment.

/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

/1/sales/{PaymentId}

Queries transaction by

PaymentId

.

/1/sales/acquirerTid/{TID}

Queries transaction by

TId

.

/1/sales?merchantOrderId={merchantOrderId}

Queries transaction by

MerchantOrderId

.

/1/RecurrentPayment/{RecurrentPaymentId}

Queries recurring transaction.