Get many Payments

Developing

Cloud Mock

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

GET

/payments/search

OperationId:get_filtered_payment_requests

Provides a means to return an ordered, pages list of payments of a given status. The payments will be return in the order of the due date.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

payments:read-Can read payment requests.

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "results": {
        "payments": [
            {
                "payment_record": {
                    "id": "e60072c9-1e7e-4458-b97b-4f0b0d8b8cb4",
                    "mandate_id": "52e441b8-7579-404d-8ee7-da3d36365927",
                    "due_date": "2026-05-04",
                    "requested_amount": 2000,
                    "currency": "GBP",
                    "status": "Confirmed",
                    "actual_amount": 2000,
                    "metadata": null,
                    "expected_payments": [
                        {
                            "expected_pay_date": "2026-05-11",
                            "amount": 2000,
                            "supply_method": "Payroll",
                            "status": "Confirmed"
                        }
                    ]
                }
            },
            {
                "payment_record": {
                    "id": "1d07279e-ebf6-4992-92a4-e29879c25692",
                    "mandate_id": "f7b57633-30af-4a06-8da3-d1f55e18fa69",
                    "due_date": "2026-05-04",
                    "requested_amount": 1100,
                    "currency": "GBP",
                    "status": "PendingSubmission",
                    "actual_amount": 0,
                    "metadata": null,
                    "expected_payments": [
                        {
                            "expected_pay_date": "2026-06-23",
                            "amount": 550,
                            "supply_method": "Payroll",
                            "status": "PendingSubmission"
                        },
                        {
                            "expected_pay_date": "2026-12-26",
                            "amount": 550,
                            "supply_method": "Payroll",
                            "status": "PendingSubmission"
                        }
                    ]
                }
            },
            {
                "payment_record": {
                    "id": "3c025c86-d18f-4b73-8bc7-6bb0764b23f9",
                    "mandate_id": "a3a6d7e1-76d1-4ef2-a55f-81515719e193",
                    "due_date": "2026-05-04",
                    "requested_amount": 29716,
                    "currency": "NGN",
                    "status": "PendingSubmission",
                    "actual_amount": 35787,
                    "metadata": null,
                    "expected_payments": [
                        {
                            "expected_pay_date": "2027-02-09",
                            "amount": 3644,
                            "supply_method": "Payroll",
                            "status": "PendingSubmission"
                        },
                        {
                            "expected_pay_date": "2026-05-30",
                            "amount": 2700,
                            "supply_method": "Payroll",
                            "status": "PendingSubmission"
                        }
                    ]
                }
            }
        ],
        "paging": {
            "limit": 2205,
            "has_more": true,
            "next_cursor": "quis Duis aute ex"
        }
    }
}

Get a Payment

Schedules