Accounts and money

Retrieve an Internal Transfer

Retrieve a single Internal Transfer by its transferId. Money moving between two Hyperscale Accounts. It never crosses the provider boundary, and a reserved transfer holds the funds until it is posted or expires.

get/v1/internal-transfers/{transferId}

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/internal-transfers/{transferId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

transferIdstring required

Query parameters

productIdstring

Hyperscale product ID

Headers

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

Response

Success

transferIdstring required

Hyperscale transfer ID

tenantIdstring required

Organization tenant ID

amountstring

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

postedAmountstring

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

currencystring
sourceAccountIdstring

Hyperscale account ID

destinationAccountIdstring

Hyperscale account ID

status'settled' | 'reversed' | 'accepted' | 'reserved' | 'posted' | 'voided' | 'failed'
expiresAtstring date-time
expiredAtstring date-time
metadataMetadata (unresolved $ref)
correctsTransferIdstring

Hyperscale transfer ID

operationIdstring

Hyperscale operation ID

productNamestring
accountLabelstring
ownerNamestring
sourceNamestring
destinationNamestring
createdAtstring date-time
postedInRangeAmountstring

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

recordedAtstring date-time

Set only on a sandbox transfer dated on its Product's clock: the wall time Hyperscale recorded it. createdAt is then the Product's business time, which runs ahead of today once the Product's sandbox clock is advanced.

Changes

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