Refund
Founder login

Refund a payment

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. A payment takes one refund: a second refund, or a refund of a payment that already has a reversal or return, is refused with transfer_lineage_conflict naming the existing transfer, and a payment with a return in progress is refused with transfer_return_exists. Platform fee transfers and payments into any account other than a Product pool cannot be refunded here.

post/v1/refunds

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/refunds
  • Auth: HTTP bearer

Headers

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

Request body

paymentTransferIdstring required

The posted payment to refund: a transfer into a Product's pool account.

amountstring

Minor units to refund, at most the payment. Omit to refund the whole payment.

reason'duplicate' | 'fraudulent' | 'requested_by_customer'
transferIdstring

Names the refund transfer. Omit to derive one from the request.

Response

Success

transferIdstring required

The refund transfer.

paymentTransferIdstring required

Hyperscale transfer ID

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

sourceAccountIdstring required

Hyperscale account ID

destinationAccountIdstring required

Hyperscale account ID

amountstring required

Positive minor-unit integer amount serialized as a string (at most 18 digits)

currency'SAR' required
reason'duplicate' | 'fraudulent' | 'requested_by_customer'
transferStatus'posted' required

Changes

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