List payins
Retrieves a paginated list of payins. Supports filtering by various criteria including payer name, amount range, creation date, rail type, status, and subaccount.
Success Responses
Error Responses
Example Error Response for Invalid Status
Authentication
RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.
Query parameters
Cursor for pagination. Use the next_cursor from the previous response to get the next page.
Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)
Filter payins by a case-insensitive substring match on the payer’s name.
Return payins whose amount_in_cents is greater than or equal to this value (in cents).
Return payins whose amount_in_cents is less than or equal to this value (in cents).
Return payins created on or after this date (YYYY-MM-DD).
Return payins created on or before this date (YYYY-MM-DD).
Filter by rail (standard_ach, same_day_ach). Can provide multiple rails as separate parameters (e.g., ?rail=standard_ach&rail=same_day_ach).
Filter by the payin’s latest status. Can provide multiple statuses as separate parameters (e.g., ?status=created&status=approved). Valid values: created, approved, initiated, debited, settled, failed, canceled.