Returns a list of bill payments for the specified business. Payments can be filtered by method and date range.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The UUID of the business to fetch bill payments for
Comma-separated list of reference numbers to filter bill payments by. Only bill payments with reference numbers matching any value in this list will be returned.
Filter payments by method.
CASH
, CHECK
, CREDIT_CARD
, ACH
, CREDIT_BALANCE
, OTHER
Filter payments by payment date. Payments made on or after this date will be included.
Filter payments by payment date. Payments made on or before this date will be included.
Filter payments by external ID (unique idempotency key). This will always yield zero or one result.
Filter bill payments by match status. If true, only matched payments will be returned. If false, only unmatched payments will be returned. Bill payments are considered matched if they are matched directly, or if they are included in a vendor payout that is matched.
Success
The response is of type object[]
.