Refund a payment
refund.create
Moves a posted payment into a Product's pool back to the account that paid it, in full or in part, as a correction of the payment. A full refund first gives back the earn-rate fees taken on the payment; a partial refund leaves them in place.
POST /v1/refunds
Scopes: transfer:write
Input
| Field | Type | Description |
|---|---|---|
paymentTransferId required | string | The posted payment to refund: a transfer into a Product's pool account. |
amount | string | Minor units to refund, at most the payment. Omit to refund the whole payment. |
reason | duplicate | fraudulent | requested_by_customer | |
transferId | string | Names the refund transfer. Omit to derive one from the request. |
idempotencyKey required | string | New per change; reuse only to retry it. |
confirmation required | refund_create | refund.create | This tool's name, once the founder agrees. |
Request sample
curl --request POST 'https://console.hyperscale0.ai/v1/refunds' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
"paymentTransferId": "<string>",
"idempotencyKey": "<string>",
"confirmation": "<refund_create | refund.create>"
}'