GET
/v2/sandbox/deposit/depositTypesDeposit Payment Types
Returns all possible deposit payment types available in the sandbox (test) environment. Use the `value` from each item as `PaymentType` when creating a sandbox deposit.
Test environment only — not available in production.
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Authorization | string | Required | Bearer {SessionToken} | Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request. |
Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422 | 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 | array | Please refer to below example for response body | List of deposit payment types. Each item has a display `label` and a `value` used as PaymentType. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": [
{
"label": "Deposit - Domestic (ACH)",
"value": "debit.BUS_ACH_Deposit"
},
{
"label": "Deposit - Domestic Wire",
"value": "debit.Deposit_Domestic_Wire"
},
…Available only in the sandbox / test environment.
Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.