Get Transfers

get

https://sandbox-api.readyremit.com/v1/transfers

The GET /transfers endpoint retrieves a list of transfers based on the provided query parameters. This operation allows you to filter and paginate through the list of transfers. It is useful for fetching transfer records associated with a specific sender, and for managing large datasets by limiting the number of records returned in a single request and skipping a specified number of records.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

senderId

string

required

The unique identifier of the sender. This parameter is used to filter the transfers by the sender's ID, ensuring that only transfers associated with the specified sender are retrieved. It helps in tracking and managing transfers for a particular sender. Example: "9ce909de-f585-4233-bdc5-fdc42cbfd7c4"

limit

integer

The maximum number of transfers to return on a single page. This parameter is used for pagination, allowing you to control the number of transfer records returned in the response. It helps in managing large datasets by breaking them into smaller, more manageable chunks. Example: 10

offset

string

The number of transfers to skip before returning values on the page. This parameter is used for pagination, allowing you to skip a specified number of transfer records and retrieve the next set of records. It helps in navigating through large datasets by specifying the starting point for the records to be returned. Example: 20

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

200The request was successful, and the response contains a list of transfer records. Each transfer record includes detailed information about the transaction, such as the transfer ID, sender ID, recipient ID, amount, status, and other relevant details.

400The request was invalid. This response typically occurs if required parameters are missing or invalid. The response includes an error message indicating the reason for the failure.

401The request is unauthorized. This response occurs when authentication credentials are missing, invalid, or expired. The response includes an error message indicating the reason for the failure.