POST/sandbox/{userId}/deposit

Create Sandbox Deposit

Simulates an incoming deposit for a user linked to the broker. Use this to fund a sandbox account before testing payment or transfer flows.

Non-production only. This endpoint is blocked in production.

Important: Do not hardcode PaymentType. Call GET /sandbox/deposit/depositTypes and use one of the returned value fields (for example "CREDIT_DOMESTIC_ACH").

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	User ID of the user under the broker.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`PaymentType`	string	Required	CREDIT_DOMESTIC_ACH \| CREDIT_INTERNATIONAL_ACH \| DOMESTIC_WIRE_DEPOSIT \| INTERNATIONAL_WIRE_DEPOSIT	Payment type for the deposit. Must be a `value` returned by `GET /sandbox/deposit/depositTypes`.
`Amount`	string	Required	100.00	Deposit amount as a string. Must be non-empty.
`Description`	string	Optional	Dummy Deposit For Test	Description for the deposit transaction.
`DepositAccountNumber`	string	Optional	1234567890	Originating account number. Defaults to `1234567890` if omitted.
`DepositSender`	string	Optional	Test Sender	Name of the deposit sender. Defaults to `"Test Sender"` if omitted.
`IntermediaryAddress`	string	Optional	Test Address	Intermediary address. Used for international wire deposits. Defaults to `"Test Address"` if omitted.
`DepositOriginatorCountry`	string	Optional	US	ISO Alpha-2 country code of the originator. Used for international wire deposits. Defaults to `"US"` if omitted.
`IntermediaryABA`	string	Optional	021502451	Intermediary ABA routing number. Used for international wire deposits. Defaults to `"021502451"` if omitted.

Example request

{
  "PaymentType": "CREDIT_DOMESTIC_ACH",
  "Amount": "100.00",
  "Description": "Dummy Deposit For Test",
  "DepositAccountNumber": "1234567890",
  "DepositSender": "Test Sender"
}

{
  "PaymentType": "CREDIT_DOMESTIC_ACH",
  "Amount": "100.00",
  "Description": "Dummy Deposit For Test",
  "DepositAccountNumber": "1234567890",
  "DepositSender": "Test Sender"
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	`TransactionNumber` — the transaction ID of the created deposit. Use this value as `TransactionNumber` in Accept, Deny, or Cancel transaction endpoints.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "TransactionNumber": "FV000757183"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "TransactionNumber": "FV000757183"
  }
}

Optional deposit fields (`Description`, `DepositAccountNumber`, `DepositSender`, `IntermediaryAddress`, `DepositOriginatorCountry`, `IntermediaryABA`) are filled with defaults server-side if omitted.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.