Skip to main content

List Bulk Transfers

Retrieve a paginated list of bulk transfers with support for filtering, sorting, and status tracking. This endpoint returns all bulk transfers associated with your account in chronological order.

Endpoint

Query Parameters

string
Filter transfers by their current status:
  • created - Initialized but not executed
  • executing - Currently processing
  • cancelled - Manually cancelled
  • expired - Past execution window
  • completed - All transfers processed
string
Cursor for fetching next page of results
  • Use value from pagination.after in previous response
string
Cursor for fetching previous page of results
  • Use value from pagination.before in previous response
integer
default:"10"
Number of records to return per page
  • Minimum: 1
  • Maximum: 100
  • Default: 10

Response Format

array
Array of bulk transfer objects
object
string
Cursor for the previous page
string
Cursor for the next page
integer
Number of records per page

Example Request

Response Examples

Error Handling

Occurs when:
  • Invalid status value provided
  • Limit outside allowed range
  • Invalid cursor format
Occurs when:
  • Missing API key
  • Invalid API key
  • Expired API key
Occurs when:
  • Insufficient permissions
  • Account restrictions

Pagination

The API uses cursor-based pagination for reliable list operations:
  1. Initial request: Specify desired limit
  2. Subsequent requests: Use the after cursor from previous response
  3. Previous page: Use the before cursor if available
For optimal performance:
  • Use reasonable page sizes (10-50 records)
  • Cache results when appropriate
  • Implement progressive loading in your UI

Rate Limits

This endpoint has the following rate limits:
  • 100 requests per minute per API key
  • Maximum of 1000 requests per hour
  • Burst limit: 20 requests per second

Best Practices

  1. Efficient Filtering
    • Use status filters to reduce response size
    • Combine filters for precise results
    • Cache frequently accessed data
  2. Pagination Handling
    • Store cursors temporarily for navigation
    • Implement infinite scroll for large lists
    • Show loading states during fetches
  3. Error Handling
    • Implement proper retry logic
    • Handle rate limits gracefully
    • Log pagination errors
  4. Performance
    • Use appropriate page sizes
    • Cache responses when possible
    • Monitor API response times

Need Help?

For additional assistance: