curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/payments/{id}/refund' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"amount": "49.00",
"notes": "Two-person tent, green — replacement for damaged pole set.",
"reason": "Two-person tent, green — replacement for damaged pole set."
}'
{
"amount": "49.00",
"amount_refunded": "string",
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_method": "card",
"payment_number": "string",
"processor": "stripe",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
Refund a create
Refund a create
POST
/
api
/
v1
/
payments
/
{id}
/
refund
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/payments/{id}/refund' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"amount": "49.00",
"notes": "Two-person tent, green — replacement for damaged pole set.",
"reason": "Two-person tent, green — replacement for damaged pole set."
}'
{
"amount": "49.00",
"amount_refunded": "string",
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_method": "card",
"payment_number": "string",
"processor": "stripe",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string
required
Payment ID (UUID)
Headers
string,null
Optional client-generated key. Replaying the same key with an identical body returns the original response without creating a duplicate refund; reusing it with a different body returns 422. Scoped per tenant.
Request body
CreateRefundRequest
string
required
string,null
string,null
Response
PaymentResponse
string
required
string
required
string (date-time)
required
string
required
string,null
string,null
string (uuid)
required
string,null (uuid)
string
required
string
required
string,null
string
required
string (date-time)
required
Status codes
| Code | Meaning |
|---|---|
201 | Refund created |
400 | Invalid request |
404 | Payment not found |
422 | Idempotency-Key reused with a different body |
428 | Idempotency-Key header required on this endpoint (configurable) |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/payments/{id}/refund' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"amount": "49.00",
"notes": "Two-person tent, green — replacement for damaged pole set.",
"reason": "Two-person tent, green — replacement for damaged pole set."
}'
{
"amount": "49.00",
"amount_refunded": "string",
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_method": "card",
"payment_number": "string",
"processor": "stripe",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
Last modified on September 21, 2026