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=0&limit=50' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "results": {
        "payments": [
            {
                "payment_record": {
                    "id": "93ce3d76-5b99-42fe-8818-6771d988cad3",
                    "mandate_id": "59aee8b7-bb57-4369-823f-fd9000609e09",
                    "due_date": "2026-03-05T11:08:22.309Z",
                    "requested_amount": 3557,
                    "currency": "TMT",
                    "expected_pay_date": "2026-02-26T11:08:22.312Z",
                    "status": "PendingSubmission",
                    "actual_amount": 17538,
                    "metadata": null
                }
            }
        ],
        "paging": {
            "limit": 2351,
            "has_more": true,
            "next_cursor": "a174df6e-8d19-e39d-edd2-0a678f85a358"
        }
    }
}

Get a Payment

Payouts