Skip to main content
POST
Void a payment

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.

Headers

Idempotency-Key
string

Makes retries safe: a repeated void with the same key replays the original response.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Payment ID (id).

Body

application/json
reason
string
Maximum string length: 1000
Example:

"Duplicate submission"

Response

Payment voided

success
boolean
Example:

true

data
object
message
string