Retrieve a list of payment requests by filter

The id of the customer associated to the payment request.

The id of the customer from the platform that is integrating with Adfin.

The status of the payment request.

• DRAFT: The payment request does not contain contact details for the payer or it is not yet distributed.
• UNPAID: The payment request is not yet paid.
• SCHEDULED: The payment request is scheduled to collect the payment via Direct Debit.
• SUBMITTED: The remaining due amount on the payment request is covered by submitted (but not yet confirmed) Direct debit payments.
• PAID: The payment request payment payment is captured.
• CANCELLED: The payment request is cancelled.
• SETTLED: THe payment request is paid out

Payment request association type.

• SINGLE - a one off payment request.
• ONE_TO_ONE - a payment request associated with a single invoice.
• PARTIAL - a payment request that is associated with an invoice that has multiple payment requests (many to one)
• BATCH - a payment request that is associated with multiple invoices (one to many)

defaults to all types if not specified.

The start date after which the payment requests pay by date should be, including the start date.

The end date before which the payment requests pay by date should be, including the end date.

The start date after which the payment requests created date should be, including the start date.

The end date before which the payment requests created date should be, including the end date.

The start time after which the payment request was paid, including the paid start time.

The end time after which the payment request was paid, including the paid end time.

The start time after which the payment requests last updated time should be, including the start time.

The end time before which the payment requests last updated time should be, including the end time.

The start time before which the payment link was seen.

The text to search for in the payment requests.

Whether the response should include details on total count and counts per statuses

The credit control status of the payment request.

• AT_RISK: The payment request is at risk of not being paid.
• EXPECTED: The payment request is expected to be paid.
• CONFIRMED: The payment request is paid.

The cashflow status of the payment request.

• UNPAID – not yet paid.
• PROCESSING – expected to be paid.
• PAID_OUT – already paid out.

Start of the cashflow period (inclusive)

End of the cashflow period (inclusive)

The direct debit mandate status.

• NO_MANDATE: payment requests linked to customers without a mandate
• AWAITING_SIGNATURE: payment requests linked to customers awaiting signature
• SIGNED: payment requests linked to customers with a signed mandate, but not yet active
• ACTIVE: payment requests linked to customers with an active mandate.

The workflow type.

• AUTO_COLLECT: automatic collection workflow, such as direct debit
• ON_DEMAND: on demain workflow, such as via open banking and card payments

amount greater than or equal to

amount less than or equal to

The id of the schedule associated to the payment request.

List of field value IDs to filter payment requests by their associated field mappings.

The review session ID to filter payment requests by

Zero-based page index (0..N)

The size of the page to be returned

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.