Capturar transação de cartão de crédito

Realiza a captura posterior de uma transação de crédito.

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/{PaymentId}/capture
Produçãohttps://api.braspag.com.br/v2/sales/{PaymentId}/capture

Captura total

Para capturar totalmente uma transação, não é necessário enviar o campo Amount.

Captura parcial

Para capturar parcialmente uma transação, envie no campo Amount o valor em centavos que deseja capturar.

AmbienteMétodoEndpoint
Sandboxapisandbox.braspag.com.br/v2/sales/{PaymentId}/capture?amount={Amount}
Produçãoapi.braspag.com.br/v2/sales/{PaymentId}/capture?amount={Amount}

Quando uma transação é submetida com o parâmetro Payment.Capture igual a “false”, é necessário fazer uma solicitação de captura posterior para confirmar a transação.

A API permite capturar transações individualmente.

Para capturar um grupo de transações, utilize o portal e-commerce. Saiba mais em:

⚠️

Atenção

  • Após cerca de 50 tentativas de captura, o autorizador bloqueia novas capturas e retorna o código 841 (excesso de tentativas). Nesse caso, não é possível capturar a transação; é necessário gerar uma nova transação.
Path Params
string
required

Campo identificador do pedido. Tamanho: 36.

Query Params
int32

Valor a ser capturado, em centavos. Verificar se a adquirente utilizada suporta uma captura parcial. Caso não seja especificado um valor, a captura será total. Tamanho: 15.

Headers
string
required
Defaults to e3c24810-18bb-4bd7-88a0-a36d6b4a0731

Identificador da loja no Gateway de Pagamento. 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 GQUAIWVDKUINZRHDQPLHUVHAIIFEIXFEXWPOYGHY

Chave pública para autenticação dupla no Gateway de Pagamento. 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 definido pela loja, 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