Capture pre-authorization

Captura uma pré-autorização existente, no valor original ou menor.

Códigos de erro

HTTPcodeSignificado
400INVALID_JSON, MISSING_DOCUMENT_ID, MISSING_TRANSACTIONAL_TOKEN, INVALID_AMOUNTBody inválido (amount deve ser > 0; não envie card/tokenData na captura).
404PAYMENT_NOT_FOUNDpaymentId não existe no seu tenant.
422INVALID_STATUSPré-autorização não elegível: já capturada, já cancelada, falhou ou expirou. A mensagem diz qual caso.
422INVALID_AMOUNTamount maior que o valor pré-autorizado.
422AUTHORIZER_REJECTED (em errors[])O emissor recusou a captura; msg traz o código de resposta.
422MSG_GENERAL_ERROR (em errors[])Erro técnico transitório no processamento — retente; a reserva continua de pé.
502ACQUIRER_COMMUNICATION_ERRORNão obtivemos resposta do adquirente (a operação não foi recusada). A pré-autorização continua de pé e a reserva segue no limite do portador. Repetir é seguro — veja "Sem resposta do adquirente" abaixo.

Sem resposta do adquirente

502 ACQUIRER_COMMUNICATION_ERROR significa que a chamada ao adquirente
não respondeu dentro do nosso tempo limite. Não é recusa e não é falha
do pagamento
: a autorização original permanece intacta.

Nesse caso, repita a mesma chamada. Esta rota não tem estado terminal:
nós recarregamos o pagamento e reenviamos a operação, inclusive dias
depois. Não é necessário abrir chamado nem criar um novo pagamento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
number

Valor a capturar (pode ser menor ou igual ao pré-autorizado)

Responses

400

Body inválido (INVALID_JSON, MISSING_DOCUMENT_ID, MISSING_TRANSACTIONAL_TOKEN, INVALID_AMOUNT)

403

Token inválido ou IP não autorizado

404

Pagamento não encontrado

422

Pré-autorização não elegível (INVALID_STATUS, INVALID_AMOUNT) ou recusa/erro do processamento (errors[])

502

ACQUIRER_COMMUNICATION_ERROR — sem resposta do adquirente. A pré-autorização continua de pé; repita a mesma chamada.

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