Accounts and money

Retrieve an account reservation

Reads one scoped reservation and its remaining ledger amount. No aggregate pending balance is turned into an individual hold.

get/v1/accounts/{accountId}/holds/{transferId}

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/accounts/{accountId}/holds/{transferId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

accountIdstring required

Hyperscale account ID

transferIdstring required

Hyperscale transfer ID

Query parameters

productIdstring

Hyperscale product ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

transferIdstring required

Hyperscale transfer ID

accountIdstring required

Hyperscale account ID

destinationAccountIdstring required

Hyperscale account ID

amountstring required

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

remainingAmountstring required

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

currency'SAR' required
status'active' | 'posted' | 'voided' | 'expired' required
operationIdstring required

Hyperscale operation ID

ownerParticipantIdstring required
originatingPrincipalIdstring nullable required
expiresAtstring date-time nullable required
createdAtstring date-time required
observedAtstring date-time required

Changes

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