curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/prepayments/{id}/refund' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"amount": "49.00",
"currency": "USD",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"number": "ORD-10042",
"remaining": "string",
"status": "pending",
"supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Refund a prepayment
Refund a prepayment
POST
/
api
/
v1
/
prepayments
/
{id}
/
refund
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/prepayments/{id}/refund' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"amount": "49.00",
"currency": "USD",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"number": "ORD-10042",
"remaining": "string",
"status": "pending",
"supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
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
Prepayment ID
Request body
No request body.Response
PrepaymentResponse
string
required
string
required
string
required
string
required
string
required
string
required
string
required
Status codes
| Code | Meaning |
|---|---|
200 | — |
409 | — |
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/prepayments/{id}/refund' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"amount": "49.00",
"currency": "USD",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"number": "ORD-10042",
"remaining": "string",
"status": "pending",
"supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Last modified on September 21, 2026