put https://apisandbox.cieloecommerce.cielo.com.br/1/sales//capture
Realiza a captura parcial ou total de uma transação de cartão de crédito.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture?amount={Amount}&serviceTaxAmount={ServiceTaxAmount} |
| Produção | put | https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture?amount={Amount}&serviceTaxAmount={ServiceTaxAmount} |
Quando a criação do pagamento de cartão de crédito é uma pré-autorização (ou seja, o parâmetro Payment.Capture foi enviado como false), é possível realizar a captura posterior.
É possível capturar um valor parcial ou o valor total da transação:
- Para captura total, não envie o campo
Amount. Será considerado o valor total da autorização; - Para captura parcial, envie o campo
Amountna requisição de captura com o valor desejado a capturar. A captura parcial é o ato de capturar um valor menor que o valor autorizado. Esse modelo de captura pode ocorrer apenas uma vez por transação.
Após uma captura, não é possível realizar capturas adicionais no mesmo pedido.
Atenção
Transações com valor inferior a 20 centavos na agenda financeira não são liquidadas. Não recomendamos realizar a captura de valores menores que 20 centavos.
Importante: companhias aéreas
- O campo
ServiceTaxAmounté exclusivo para empresas aéreas;- Para realizar a captura da taxa de embarque, basta adicionar o valor do
ServiceTaxAmounta ser capturado.