List Deposits

Retrieves a list of Deposits.

Query Params
string
enum
required

The current status of the deposit to filter by.

Show Details
STARTEDA new deposit request was received.
PENDINGThe deposit details were accepted.
PROCESSINGThe deposit is being processed.
SUCCESSFULThe deposit was successful.
FAILEDThe deposit was not successful.
OTHERThe deposit is in a suspended state.
APPROVEDThe deposit was approved.
REJECTEDThe deposit was rejected.
ON_HOLDThe deposit details were accepted, but it is not yet ready to be processed.
RETURNEDThe deposit was returned to the originating bank.
-An error occurred during the deposit.
string
enum
required

The type of deposit to filter by.

Show Details
ACHArriving via ACH transfer.
BULK_FUNDINGArriving via bulk funding.
CASH_PROMOTIONA promotional cash credit.
CASH_TRANSFERArriving via cash transfer.
Allowed:
string
required

The date to start from.

string
required

The date to end at.

string
enum

The direction of pagination.

Show Details
prevFetch the previous page of results.
nextFetch the next page of results.
Allowed:
string

Filters the deposits list by the partnerID.

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json