Accounts and money
Founder login

Initiate a transfer return

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. No money moves until the return completes: in sandbox the next clock advance or maintenance tick completes it, and in live Hyperscale operations complete it once the provider settles the return. waitsFor names which. A return may target a reversal's compensating transfer, but a return of a return is refused: the original return is dishonored instead. A transfer that already has a refund, reversal or adjustment is refused with transfer_lineage_conflict.

post/v1/transfer-returns

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/transfer-returns
  • Auth: HTTP bearer

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

returnIdstring

Hyperscale transfer return ID

originalTransferIdstring required

Hyperscale transfer ID

reason'insufficient_funds' | 'account_closed' | 'no_account' | 'invalid_account' | 'balance_cap_exceeded' | 'unauthorized' | 'other' required

Response

Success

returnIdstring required

Hyperscale transfer return ID

tenantIdstring required

Organization tenant ID

originalTransferIdstring required

Hyperscale transfer ID

reason'insufficient_funds' | 'account_closed' | 'no_account' | 'invalid_account' | 'balance_cap_exceeded' | 'unauthorized' | 'other' required
windowExpiresAtstring date-time required
returnStatus'initiated' required
waitsFor'sandbox_clock_advance' | 'provider_settlement' required

What completes the return. In sandbox, the next sandbox clock advance or maintenance tick, within about a minute. In live, the provider settling the return, after which Hyperscale operations complete it.

Changes

No recorded changes to this operation across all 1 revision of this API.