Products

Settle product earnings

Moves accumulated earnings from the product revenue account to the tenant settlement account. The ledger rejects settling more than the revenue account holds.

post/v1/products/{productId}/earnings/settlements

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/products/{productId}/earnings/settlements
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

productIdstring required

Hyperscale product ID

Headers

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

Request body

transferIdstring

Hyperscale transfer ID

amountstring required

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

currency'SAR' required

Response

Success

transferIdstring 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
transferStatus'posted' required

Changes

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