Capturar transação de crédito após a autorização

Realiza a captura parcial ou total de uma transação de cartão de crédito.

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture?amount={Amount}&serviceTaxAmount={ServiceTaxAmount}
Produçãohttps://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 Amount na 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;
  • Existe uma limitação no número de tentativas de captura. Quando são realizadas aproximadamente 50 tentativas, o autorizador bloqueia novas capturas e retorna o código 841 (excesso de tentativas de captura). Após esse bloqueio, não é mais possível capturar a transação. Para concluir a operação, é necessário gerar uma nova transação.
ℹ️

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 ServiceTaxAmount a ser capturado.
Path Params
string
required

Número de identificação do pagamento, retornado pela API na criação do pagamento de cartão de crédito. Tamanho: 36.

Query Params
int32

Valor a ser capturado, em centavos. Se essa campo não for preenchido, o valor da captura será o valor total da autorização. Tamanho: 15.

int32

Aplicável apenas para empresas aéreas. Montante do valor da autorização que deve ser destinado à taxa de serviço. O valor do ServiceTaxAmount será liquidado integralmente junto com o valor da primeira parcela.. Tamanho: 15.

Headers
string
required
Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Identificador da loja na Cielo. Tamanho: 36. Formato: GUID.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

string
required
Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Chave pública para autenticação dupla na API. Tamanho: 40. Formato: GUID.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

string

Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json