These docs are for v4. Click to read the latest docs for v5.

Capturando uma transação posteriormente

Essa rota é utilizada para capturar uma transação, após aprovada, utilizando o token ou o ID da transação.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

O que é uma captura?

📘

Captura de uma transação

O processo de captura representa a confirmação junto ao banco emissor de uma autorização previamente criada. Significa dizer: "Confirmo a cobrança deste valor na fatura do portador deste cartão", ou seja, o valor de fato será cobrado. Caso não seja executada, o próprio banco emissor cancela a operação de autorização e devolve o saldo reservado ao cartão do portador.

Restrições ao tempo para captura de uma transação

🚧

Tempo para captura de uma transação

Para uma transação que tenha sido criada através de uma api_key, sua plataforma tem até 5 dias para solicitar o processo de captura através desta rota.

Captura em transações de boleto

Ao chamar a rota /capture para uma transação de boleto, você na verdade está solicitando a criação as informações pertinentes ao boleto, observe:

🚧

Captura de boleto

Uma transação de boleto apenas autorizada não gera os dados de boleto: url e código de barras. Apenas após a captura essas informações são criadas.

Captura parcial

Você pode passar o parâmetro amount na rota de /capture de uma transação, mas é importante seguir esta observação:

🚧

Valores para captura

Nossa API permite que sua aplicação capture um valor menor ou igual ao que foi autorizado em sua transação, entretanto, isso é válido apenas para transações criadas com sua api_key. Para os casos que uma encryption_key tenha sido usada, o valor de autorização deve ser o mesmo para captura, sendo que ambos devem refletir o valore do seu carrinho de compras.

Path Params
string
required

Id ou o token da transação a ser capturada

Query Params
int32
required

Valor a ser capturado. Deve ser passado em centavos. Ex: R$ 10.00 = 1000.

split_rules
array of objects

Regras de divisão da transação

split_rules
json

Metadata de informações adicionais, caso queira incluir, i.e: Id do pedido, nome do produto, etc.

Response

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