Hyperscale docs Sign in Start building

Deposit money into an account through a bank adapter

account.deposit

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

Scopes: transfer:write

Input

FieldTypeDescription
transferIdstringHyperscale transfer ID
destinationAccountId requiredstringHyperscale account ID
adapter requiredstringThe bank adapter that delivers the deposit, such as `fixture_bank`
amount requiredstringPositive minor-unit integer amount serialized as a string, capped at 15 digits per call
currency requiredstring
idempotencyKey requiredstringNew per change; reuse only to retry it.
confirmation requiredaccount_deposit | account.depositThis tool's name, once the founder agrees.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/account-deposits' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "destinationAccountId": "<string>",
  "adapter": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "idempotencyKey": "<string>",
  "confirmation": "<account_deposit | account.deposit>"
}'

All operations