DRdrivewealth
Deposits

List Deposits

Retrieves a list of Deposits.

get/funding/deposits

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/funding/deposits
  • Auth
    HTTP bearer

Query parameters

status'STARTED' | 'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED' | 'OTHER' | 'APPROVED' | 'REJECTED' | 'ON_HOLD' | 'PROCESSING' | 'RETURNED' | '-' required

The current status of the user's deposit.

Example:PENDING

The current status of the deposit to filter by.

type'ACH' | 'BULK_FUNDING' | 'CASH_PROMOTION' | 'CASH_TRANSFER' required

The method/form in which the funds will be arriving to the user's account.

Example:ACH

The type of deposit to filter by.

fromstring required

The date to start from.

tostring required

The date to end at.

direction'prev' | 'next'

The direction of pagination.

parentIBIDstring

The partner's unique identifier.

Example:123e4567-e89b-12d3-a456-000000000005

Filters the deposits list by the partnerID.

Response

Retrieving a list of Deposits was Successful.

idstring

A unique identifier for the Deposit.

type'ACH' | 'BULK_FUNDING' | 'CASH_PROMOTION' | 'CASH_TRANSFER'

The method/form in which the funds will be arriving to the user's account.

amountnumber

The amount of the deposit

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

Changes

No recorded changes to this operation across all 1 revision of this API.