Initiate a transfer return
transfer_return.create
Opens a return against a posted transfer, or against a completed payout by also naming the payout. Admission enforces the per-reason time window against the posted moment.
POST /v1/transfer-returns
Scopes: transfer:write
Input
| Field | Type | Description |
|---|---|---|
returnId | string | Hyperscale transfer return ID |
originalTransferId required | string | Hyperscale transfer ID |
reason required | insufficient_funds | account_closed | no_account | invalid_account | balance_cap_exceeded | unauthorized | other | |
idempotencyKey required | string | New per change; reuse only to retry it. |
confirmation required | transfer_return_create | transfer_return.create | This tool's name, once the founder agrees. |
Request sample
curl --request POST 'https://console.hyperscale0.ai/v1/transfer-returns' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
"originalTransferId": "<string>",
"reason": "<insufficient_funds | account_closed | no_account | invalid_account | balance_cap_exceeded | unauthorized | other>",
"idempotencyKey": "<string>",
"confirmation": "<transfer_return_create | transfer_return.create>"
}'