Home
Home
  1. Payment Requests
  • Welcome
    • About Ontime
    • Overview
    • Test and Learn Projects
  • Authentication
  • Availability Check
    • Light Availability Check
      POST
    • Full Availability Check
      POST
  • Payment Management
    • Mandates
      • Create a new mandate
      • Cancel an existing mandate
      • Get a Mandate
      • Get many Mandates
    • Payment Requests
      • Instruct a new payment request
        POST
      • Cancel an existing payment request
        DELETE
      • Get a Payment
        GET
      • Get many Payments
        GET
  • Payouts
    • Get a Payout
      GET
    • Get Available Payouts
      GET
  • Webhooks
    • Mandate Created/Updated
    • Payment Request Created/Updated
    • Payout Created
  1. Payment Requests

Get many Payments

Developing
Cloud Mock
https://mock.apidog.com/m1/828215-0-default
Cloud Mock
https://mock.apidog.com/m1/828215-0-default
GET
https://mock.apidog.com/m1/828215-0-default
/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.
or
Query Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/828215-0-default/payments/search?status&start_index=0&limit=50' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "results": {
        "payments": [
            {
                "payments": {
                    "id": "64839af2-bec1-4a19-978e-626e9c0f1fef",
                    "mandate_id": "f5f82274-d3ab-42a1-88b2-366896f3694c",
                    "due_date": "2025-07-04T12:44:47.027Z",
                    "requested_amount": 28373,
                    "currency": "GBP",
                    "expected_pay_date": "2025-06-27T12:44:47.033Z",
                    "status": "PendingSubmission"
                }
            }
        ],
        "paging": {
            "start_index": 2712516315783318,
            "count": 3847211002302453,
            "previous_page": "/search?start_index=0&limit=50",
            "next_page": "/search?start_index=51&limit=50"
        }
    }
}
Previous
Get a Payment
Next
Payouts