Skip to main content
POST
Capture an authorized payment

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Path Parameters

id
string
required
Example:

"pay_abc123"

Body

application/json
amount
integer

Amount to capture, in cents. Omit for full capture.

Required range: x >= 1
metadata
object

Key-value pairs. ≤50 keys, keys ≤40 chars, values are strings ≤500 chars (or null to clear). Nested structures must be JSON-stringified into a single string value.

Response

Captured

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string