New filtering and sorting capabilities when retrieving payment runs
Effective:
- 25 June 2024 on Sandbox
- 26 June 2024 on Live
We have made improvements to the get payment runs endpoint, enabling you to filter and sort the returned payment runsPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..
By default, the list of payment runsPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution. will be sorted in descending order based on their creation date, meaning the newest payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution. will appear at the top of the list. This ensures that the most recent payment runsPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution. are immediately visible for easy access.
The following filters are now supported:
status- The status of the payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..reference- The unique paymentRunRef of the payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..min_amount- The minimum total amount of the payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..max_amount- The maximum total amount of the payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..
Affected Endpoint