Skip to main content
POST
Capture a payment (not supported)

Authorizations

Authorization
string
header
required

Send your API key as Authorization: ApiKey pc_<your-key>. The API also accepts the key without the ApiKey prefix. API keys authenticate requests to /api/partner/v1/*. Contact GroGov support to rotate your key or deactivate your API account. Rotation invalidates the previous key. Account deactivation blocks both API keys and access tokens.

Path Parameters

id
string<uuid>
required

Payment ID.

Body

application/json
amountCents
integer

Reserved capture amount in cents. Capture requests return 501 CAPTURE_NOT_SUPPORTED.

Example:

10000

Response

501 - application/json

CAPTURE_NOT_SUPPORTED

success
boolean
Example:

false

message
string
Example:

"Payment was declined."

details
object