Retrieve the list of payment requests for a given filter

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The id of the customer associated to the payment request.

string

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

string

The status of the payment request.

  • DRAFT: The payment request does not contain contact details for the payer or it is not yet distributed.
  • REQUESTED: 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
string

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.

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

The start time before which the payment link was seen.

date-time
string

The text to search for in the payment requests.

string

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

string

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.
string

The cashflow status of the payment request.

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

Start of the cashflow period (inclusive)

string

End of the cashflow period (inclusive)

string

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.
string

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
string
≥ 0

amount greater than or equal to

string
≥ 0

amount less than or equal to

string

The id of the schedule associated to the payment request.

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 50

The size of the page to be returned

sort
array of strings
Defaults to creationTime,DESC

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

sort
Responses

400

A problem reading or understanding the request. Ensure that the request complies with the required format and includes all necessary parameters.

401

Authentication required - Invalid or missing authorization headers.

422

A request validation error.

500

The server could not process the request.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json