Filtering and Sorting Capabilities
Both the payer and payee list endpoints support advanced filtering and sorting options to help you retrieve the specific data you need.
Payee List Endpoint
Filtering Options
-
Creation Date
- Filter by exact date:
createdAt - Filter by date range:
createdAt[gte],createdAt[lte],createdAt[gt],createdAt[lt]
- Filter by exact date:
-
Bulk Batch ID
- Exact match:
labels.bulkBatchId - Multiple values:
labels.bulkBatchId[in]
- Exact match:
-
Payer-owned Data
- Payee Name:
- Exact match:
payerOwnedData.payeeName - Contains:
payerOwnedData.payeeName[contains]
- Exact match:
- Payee Company Name:
- Exact match:
payerOwnedData.payeeCompanyName - Contains:
payerOwnedData.payeeCompanyName[contains] - Multiple values:
payerOwnedData.payeeCompanyName[in]
- Exact match:
- Payee External ID:
- Exact match:
payerOwnedData.payeeExternalId - Not equal:
payerOwnedData.payeeExternalId[ne]
- Exact match:
- Status:
- Exact match:
payerOwnedData.status - Multiple values:
payerOwnedData.status[in]
- Exact match:
- Auto Pay Strategy:
- Exact match:
payerOwnedData.autoPayStrategy - Multiple values:
payerOwnedData.autoPayStrategy[in]
- Exact match:
- Payee Name:
-
Payee-owned Data
- Share Tax Document:
- Exact match:
payeeOwnedData.shareTaxDocument - Multiple values:
payeeOwnedData.shareTaxDocument[in]
- Exact match:
- Share Tax Document:
Sorting Options
- Sort by creation date:
sort=createdAt:ascorsort=createdAt:desc - Sort by update date:
sort=updatedAt:ascorsort=updatedAt:desc
Pagination
- Page number:
page[number]=<number> - Page size:
page[size]=<number>(max 1000)
Default Sort
If no sort parameter is provided, results are sorted by updatedAt in ascending order.
Payer List Endpoint
Filtering Options
-
Payer ID
- Exact match:
payerId - Not equal:
payerId[ne]
- Exact match:
-
Payee-owned Data
- Payer Name:
- Exact match:
payeeOwnedData.payerName - Contains:
payeeOwnedData.payerName[contains]
- Exact match:
- Payer Company Name:
- Exact match:
payeeOwnedData.payerCompanyName - Contains:
payeeOwnedData.payerCompanyName[contains] - Multiple values:
payeeOwnedData.payerCompanyName[in]
- Exact match:
- Payer External ID:
- Exact match:
payeeOwnedData.payerExternalId
- Exact match:
- Status:
- Exact match:
payeeOwnedData.status - Multiple values:
payeeOwnedData.status[in]
- Exact match:
- Payer Name:
Sorting Options
- Sort by update date:
sort=updatedAt:ascorsort=updatedAt:desc
Pagination
- Page number:
page[number]=<number> - Page size:
page[size]=<number>(max 1000)
Default Sort
If no sort parameter is provided, results are sorted by updatedAt in ascending order.