Skip to main content
POST
Chame POST /payment/{id}/capture para liquidar fundos de um POST /payment/authorization anterior. Você pode capturar menos do que o valor total autorizado — uma captura parcial — e a retenção restante é liberada automaticamente. Você deve chamar este endpoint dentro da janela de autorização do adquirente (normalmente 7 dias) ou a retenção expira e você precisará autorizar novamente.

Identificar o pagamento

{id} é o id de pagamento do Therius devolvido na resposta a POST /payment/authorization (e POST /payment/purchase). Guarde-o quando você cria o pagamento. orderCode e paymentCode são os seus próprios campos de referência — não são aceitos como forma de endereçar o pagamento para captura, reembolso ou cancelamento. Um id que não existe, ou que pertence a outro lojista, devolve 404.

Exemplo

Captura total

Captura parcial

Quando você faz uma captura parcial, o Therius libera automaticamente a retenção restante ($24.00 no exemplo acima). Você não precisa enviar uma requisição de cancelamento separada para a parte não capturada.
Você só pode capturar um pagamento autorizado uma vez. Se você precisar capturar um valor diferente depois que uma captura parcial já foi processada, você precisará criar uma nova autorização.
Passe sempre um Idempotency-Key na captura. Se o seu servidor esgotar o tempo limite e você tentar de novo, a mesma chave garante que você não liquidará duas vezes a mesma autorização.

Autorizações

Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Cabeçalhos

Idempotency-Key
string<uuid>

A UUID you generate per operation. Required in production. Retrying with the same key returns the original response.

Parâmetros de caminho

id
string<uuid>
obrigatório

The Therius payment id returned by POST /payment/authorization or POST /payment/purchase.

Corpo

application/json
merchantCode
string
obrigatório

Your merchant account identifier. Validated against the Bearer key's merchant; required if the key maps to more than one merchant account.

amount
object
obrigatório
reference
string

Optional internal reference for this capture operation.

Resposta

200 - application/json

Capture result

Result of a capture, refund, cancel or cancel_or_refund.

id
string

The Therius payment id.

merchantCode
string
orderCode
string
paymentCode
string

Therius receipt ID.

amount
object
status
enum<string>

Outcome of the operation.

Opções disponíveis:
captured,
refunded,
cancelled,
failed