Refund charge
Refund a charge. You can refund the full amount or specify a partial refund amount. Multiple partial refunds can be issued until the full amount is refunded.
Related endpoints
POST /charges— Create a one-time chargeGET /charges— List chargesGET /charges/{id}— Get chargePOST /charges/{id}/capture— Capture charge
Common errors
400 invalid_request— malformed payload or failed validation.401 unauthenticated— missing, malformed, or revoked API key.404 resource_missing— the referenced resource does not exist or is not visible to your key.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/charges/00000000-0000-0000-0000-000000000000/refund" \
-H "x-api-key: $REVKEEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"amountMinor": 0,
"reason": "duplicate",
"notes": "string"
}'{
"data": {
"id": "string",
"customerId": "string",
"invoiceId": "string",
"paymentMethodId": "string",
"amountMinor": 0,
"amountCapturedMinor": 0,
"amountRefundedMinor": 0,
"currency": "str",
"status": "pending",
"description": "string",
"statementDescriptor": "string",
"failureCode": "string",
"failureMessage": "string",
"gatewayTransactionId": "string",
"receiptUrl": "string",
"captured": true,
"metadata": {
"property1": null,
"property2": null
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}{
"error": "Bad request"
}{
"error": "Unauthorized"
}{
"error": "Not found"
}