Skip to main content
POST
Call POST /payment/{id}/capture to settle funds from an earlier POST /payment/authorization. You can capture less than the full authorized amount — a partial capture — and the remaining hold is released automatically. You must call this endpoint within the acquirer’s authorization window (typically 7 days) or the hold will expire and you’ll need to re-authorize.

​
Identifying the payment

{id} is the Therius payment id returned in the response to POST /payment/authorization (and POST /payment/purchase). Store it when you create the payment. orderCode and paymentCode are your own reference fields — they are not accepted as a way to address the payment for capture, refund or cancel. An id that does not exist, or that belongs to another merchant, returns 404.

​
Example

​
Full capture

​
Partial capture

When you perform a partial capture, Therius automatically releases the remaining hold ($24.00 in the example above). You do not need to send a separate cancel request for the uncaptured portion.
You can only capture an authorized payment once. If you need to capture a different amount after a partial capture has already been processed, you’ll need to create a new authorization.
Always pass an Idempotency-Key on capture. If your server times out and you retry, the same key guarantees you won’t double-settle the same authorization.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string<uuid>

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

Path Parameters

​
id
string<uuid>
required

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

Body

application/json
​
merchantCode
string
required

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

​
amount
object
required
​
reference
string

Optional internal reference for this capture operation.

Response

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.

Available options:
captured,
refunded,
cancelled,
failed