REST API›Fiat

POST

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.

Header Params

  • user-id string required
    The authenticated user's ID (set by auth-service).

Body Params

object

Request body for creating a simulated test deposit transaction. Only testnet currencies are accepted. Non-production only.
  • walletId string required
    The Go Account wallet ID to create the deposit for.

    at least 1 characters

  • currency string required
    A testnet backing fiat currency (e.g., tfiatusd, tfiateur, tfiatsgd).
  • amount string
    The deposit amount in cents as a string. Defaults to "1000" (i.e., $10.00) if not provided.

    Defaults to 1000

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

    Defaults to wire

    wireach
  • instantCreditEligible boolean
    Whether the transaction is eligible for instant credit. Only relevant for ACH transactions. When true and type is ach, the platform is notified immediately.
  • withdrawHoldReleaseAt string date-time
    Optional ISO 8601 datetime for when a withdraw hold should be released.
  • description string
    Optional custom description for the simulated deposit. When provided, replaces the default description. When omitted, defaults to "Test Deposit for {currency} wallet {walletId}".

    at least 1 characters

Responses

200
OK

Response Body

string

400
Bad Request – invalid or missing parameters

Response Body

object

  • errorName string required
  • error string required
403
Forbidden – missing user-id header or user does not have access to the wallet's enterprise

Response Body

object

  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

  • errorName string required
  • error string required