Get Deposit List

get

https://api-uat.ncome.in/api/v1/deposits

This API fetches a list of deposits associated with the Digital Escrow IDs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageNum

string

The "pageNum" parameter specifies the page number of the list that is to be fetched. It indicates which page of results from the list should be returned in the API response.

pageSize

string

The request parameter "pageSize" specifies the maximum number of items that can be returned per page in the API response. The maximum allowed value for this parameter is 10,000 items.

banks

string

Specify the Digital Escrow ID "banks" for which the deposit list is required. Acceptable values are: axis, rbl, bob, and dbs. This identifies the bank from which to retrieve the deposit list.

startDate

date-time

This parameter specifies the start date from which the deposit list will be fetched, based on the deposit date. It indicates the earliest date from which deposits should be included in the fetched list. The date should be provided in epoch format.

endDate

date-time

This parameter specifies the end date until which the deposit list will be fetched, based on the deposit date. It indicates the latest date up to which deposit should be included in the fetched list. The date should be provided in epoch format.

escrowId

string

Digital Escrow ID for which deposit list is required

Headers

X-Client-Key

string

Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

x-api-key

string

Defaults to {{x-api-key}}

xAPI key shared separately by Castler

Responses

200200

400400

403403

500500