Get Transfer request List

get

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

This API fetches a list of single transfer requests, providing details of each transfer initiated from the Digital Escrow ID

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.

escrowId

string

specify the digital escrow id for which the transfer list is required.

banks

array of strings

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.

banks

status

array of strings

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.

status

startDate

date-time

This parameter specifies the start date from which the transfer list will be fetched, based on the transfer creation date. It indicates the earliest date from which transfers 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 transfer list will be fetched, based on the transfer creation date. It indicates the latest date up to which transfers should be included in the fetched list. 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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

403403

500500