Refund a payment

curl --request POST \ --url https://apistagepc.grogov.us/api/partner/v1/payments/{id}/refund \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "reason": "Case dismissed" } '

{ "success": true, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "target": "group", "reversalType": "refund", "amountCents": 10300, "currency": "USD", "reason": "Case dismissed", "status": "succeeded", "remainingRefundableAmountCents": 0, "gateway": { "transactionId": "4938271649" }, "createdAt": "2024-03-01T12:00:00.000Z" } }

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

Maximum string length: 255

Path Parameters

string<uuid>

required

Payment ID (id). Line-item IDs are not accepted.

Body

application/json

amountCents

integer

Principal to refund, in cents. Omit to refund all of the remaining principal.

Required range: x >= 1

Example:

5000

feeType

enum<string>

default:exclude_fee

include_fee also refunds the service fee, and only applies when amountCents is omitted (a full refund). Partial refunds return principal only.

Available options:

include_fee,

exclude_fee

reason

string

Maximum string length: 1000

Example:

"Case dismissed"

Response

Refund processed.

success

boolean

Example:

true

data

object

Returned when refunding a payment.

Show child attributes

message

string

Auth

Vault

Payments

Hosted checkout

API Reference

Authorizations

Headers

Path Parameters

Body

Response