POST
/v2/sandbox/depositDeposit Balance
Creates a deposit transaction into the merchant account for testing. The returned `TransactionNumber` can be used with Get Transaction Details and with Authorize / Deny / Cancel Transaction.
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. |
Request body
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Amount | string | Required | 100 | Amount to deposit into the merchant account. |
PaymentType | string | Required | debit.BUS_ACH_Deposit | debit.Deposit_Domestic_Wire | debit.Business_Deposit | debit.Credit_IAT_ACH | debit.Deposit_Bridge_Wire | debit.Deposit_Third_Party_Custodial_Transfer | debit.Stablecoin_Deposit | Deposit rail / type. Get allowed values from Deposit Payment Types. |
Description | string | Optional | Dummy Deposit For Test | Optional memo for the deposit. Defaults to a test description if omitted. |
Example request
{
"Amount": "100",
"PaymentType": "debit.Deposit_Domestic_Wire",
"Description": "Dummy Deposit For Test"
}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 | object | Please refer to below example for response body | Contains TransactionNumber for the pending deposit. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"TransactionNumber": "FV000023005"
}
}The deposit is created as a pending transaction. Use Authorize Transaction to complete it in sandbox.
Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.