GET/sandbox/deposit/depositTypes

Get Deposit Types

Returns the allowed PaymentType values for creating a sandbox deposit. Pass the value field from this response as PaymentType when calling POST /sandbox/{userId}/deposit.

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

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.

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	Array of available deposit payment types. Each item has a `label` (human-readable name) and a `value` to pass as `PaymentType` in Create Sandbox Deposit.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": [
    {
      "label": "CREDIT – ACH DOMESTIC TRANSACTION",
      "value": "CREDIT_DOMESTIC_ACH"
    },
    {
      "label": "CREDIT - INTERNATIONAL ACH TRANSACTION (IAT)",
      "value": "CREDIT_INTERNATIONAL_ACH"
    },
    {
      "label": "Deposit - Domestic Wire",
      "value": "DOMESTIC_WIRE_DEPOSIT"
    },
    {
      "label": "Deposit - International Wire",
      "value": "INTERNATIONAL_WIRE_DEPOSIT"
    }
  ]
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": [
    {
      "label": "CREDIT – ACH DOMESTIC TRANSACTION",
      "value": "CREDIT_DOMESTIC_ACH"
    },
    {
      "label": "CREDIT - INTERNATIONAL ACH TRANSACTION (IAT)",
      "value": "CREDIT_INTERNATIONAL_ACH"
    },
    {
      "label": "Deposit - Domestic Wire",
      "value": "DOMESTIC_WIRE_DEPOSIT"
    },
    {
      "label": "Deposit - International Wire",
      "value": "INTERNATIONAL_WIRE_DEPOSIT"
    }
  ]
}

Do not hardcode `PaymentType` values. Always call this endpoint first and use one of the returned `value` fields — the list may change.

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