Dom Docs
Dom Pagamentos

Atualizar status de um pagamento pré-autorizado

PUThttps://{apiUrl}/transactions/authorize/{id}

Atualizado em · 2 min de leitura

Este endpoint permite capturar (autorizar) ou cancelar uma transação previamente criada com o parâmetro capture = false e que contenha o status Autorizado.

PUThttps://{apiUrl}/transactions/authorize/{id}
URL base da API
Token de autenticação
Path Params
idstringrequired

Identificador único da transação (UUID)

Body Params
authorizebooleanrequired

true para capturar, false para cancelar a pré-autorização

totalfloatoptional

Valor a capturar (para captura parcial — deve ser menor que o valor total)

curl --request PUT \
  --url "https://{apiUrl}/transactions/authorize/{id}" \
  --header "Content-Type: application/json" 
  --data '{}'
Response

Choose an example:

application/json
Responses

Ao realizar a chamada, é possível:

  • Capturar a transação, definindo authorize = true.
  • Cancelar a transação, definindo authorize = false.

Além disso, durante a captura (authorize = true), é possível informar um valor menor do que o total originalmente autorizado, através do campo total. Não é permitido capturar um valor superior ao autorizado.

A resposta retornará:

  • Um campo status, que indica o resultado da operação:
    • OK — operação concluída com sucesso.
    • FAIL — erro durante o processo.
  • O objeto order, contendo os dados atualizados da transação.
Esta página foi útil?