Lista de recursos

Confira a seguir os recursos disponíveis em Checkout e Link de Pagamento

API transacional

URL produção: https://cieloecommerce.cielo.com.br/api/public

MétodoEndpointDescrição
/v2/tokenGera o token de acesso.
/v1/products/Cria um link de pagamento.
/v1/products/{id}Atualiza um link de pagamento existente ao informar o id do link.
/v1/RecurrentPayment/Update
  • Atualiza um link de pagamento recorrente;
    - Atualiza uma recorrência do Checkout
/v1/products/{id}Consulta um link de pagamento.
/v1/RecurrentPayment/{pagadorRecurrentPaymentId}
  • Consulta um link de pagamento recorrente;
    - Consulta uma recorrência do Checkout.
/v1/products/{id}Exclui um link de pagamento existente.
/v1/RecurrentPayment/Deactivate/{pagadorRecurrentPaymentId}
  • Desativa um link de pagamento recorrente;
    - Desativa uma recorrência do Checkout.
/v1/orders/Cria a página de pagamento do Checkout.
/v2/merchantOrderNumber/{order_number}Consulta uma transação pelo order_number.
/v2/orders/{checkout_cielo_order_number}Consulta uma transação pelo Checkout_Cielo_Order_Number
/v1/products/{id}/paymentsConsulta uma transação pela Id do link de pagamento.
/v2/orders/{checkout_cielo_order_number}/captureCaptura valor total da transação.
/v2/orders/{checkout_cielo_order_number}/capture?amount={amount}Captura parte do valor da transação.
/v2/orders/{checkout_cielo_order_number}/voidCancela o valor total da transação.
/v2/orders/{checkout_cielo_order_number}/void?amount={amount}Cancela parte do valor da transação.