Accounts and money

Deposit money into an account through a bank adapter

Asks the bank adapter to deliver a deposit and posts its credit notification from the company's bank mirror into the account. The fixture bank moves fake money in sandbox, and in live on an estate that declares HYPERSCALE_LIVE_MONEY=fixture.

post/v1/account-deposits

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/account-deposits
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

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

Request body

transferIdstring

Hyperscale transfer ID

destinationAccountIdstring required

Hyperscale account ID

adapterstring required

The bank adapter that delivers the deposit, such as fixture_bank

amountstring required

Positive minor-unit integer amount serialized as a string, capped at 15 digits per call

currency'SAR' required

Response

Success

transferIdstring required

Hyperscale transfer ID

tenantIdstring required

Organization tenant ID

sourceAccountIdstring required

Hyperscale account ID

destinationAccountIdstring required

Hyperscale account ID

adapterstring required
bankReferencestring required
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.