Search payment requests with filtering and pagination

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

GET

/payments/search

OperationId:searchPaymentRequests

Retrieves a cursor paginated list of payment requests for the authenticated biller, with optional status filtering. Results are ordered by due date, earliest first. To get the next page pass paging.next_cursor as the cursor parameter; next_cursor is omitted on the last page. When filtering by status a page can contain fewer results than the limit, or none, while has_more is still true.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Responses

🟢200Success

application/json

Successful search response

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://mock.apidog.com/m1/828215-0-default/payments/search?status=&cursor=&limit=' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: <api-key>'

Response Example

200 - Success Example

{
    "results": {
        "payments": [
            {
                "payment_record": {
                    "id": "69385c01-872b-41c9-a298-dd4c46715ed5",
                    "mandate_id": "dad4b0a1-8f01-4317-b12b-4c872b398f54",
                    "schedule_id": null,
                    "requested_amount": 36338,
                    "currency": "GBP",
                    "due_date": "2026-08-11",
                    "expected_pay_date": "2026-08-04",
                    "status": "Confirmed",
                    "actual_amount": 36338,
                    "expected_payments": [
                        {
                            "sequence": 1,
                            "expected_pay_date": "2026-08-04",
                            "amount": 36338,
                            "status": "Confirmed",
                            "supply_method": "Payroll"
                        }
                    ],
                    "metadata": null
                }
            }
        ],
        "paging": {
            "limit": 50,
            "has_more": true,
            "next_cursor": "eyJsYXN0S2V5IjoiYWJjMTIzIn0="
        }
    }
}

Get a Payment

Schedules