Fiat

Simulate a test deposit

Creates a simulated test deposit transaction for a wallet in non-production environments. Requires the calling user to be an owner or member of the wallet's enterprise. Blocked in production.

post/api/fiat/v1/sandbox/transaction/simulate

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/fiat/v1/sandbox/transaction/simulate
  • Auth
    none declared. Required headers: user-id

Headers

user-idstring required

The authenticated user's ID (set by auth-service).

Request body

walletIdstring required

The Go Account wallet ID to create the deposit for.

currencystring required

A testnet backing fiat currency (e.g., tfiatusd, tfiateur, tfiatsgd).

amountstring

The deposit amount in cents as a string. Defaults to "1000" (i.e., $10.00) if not provided.

type'wire' | 'ach'

The transaction type. Defaults to "wire". ACH transactions are created in an incomplete/delayed state with a 1-day clearing window.

instantCreditEligibleboolean

Whether the transaction is eligible for instant credit. Only relevant for ACH transactions. When true and type is ach, the platform is notified immediately.

withdrawHoldReleaseAtstring date-time

Optional ISO 8601 datetime for when a withdraw hold should be released.

descriptionstring

Optional custom description for the simulated deposit. When provided, replaces the default description. When omitted, defaults to "Test Deposit for {currency} wallet {walletId}".

Response

OK

Changes

No operation changes recorded.