Get Bulk Transfer Request List

get

https://api-uat.ncome.in/api/v1/transfer/bulk

API to fetch the list of bulk transfers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

escrowId

string

The Escrow ID for which the bulk transfer details are to be retrieved.

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 transfer list is required. Acceptable values are: axis, rbl, bob, and dbs. This identifies the bank from which to retrieve the transfer list.

status

string

Specify the "status" filter for specific transfers. Acceptable values include: initiated, sent for processing, success, and failed. This filter allows you to retrieve transfers based on their current processing status.

startDate

date-time

required

The date from which the transfers should be retrieved. The date should be provided in epoch format.

endDate

date-time

required

The date up to which the transfers should be retrieved. The date should be provided in epoch format.

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

401401

403403

500500