Home
Home
  1. Payouts
  • 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
      • Cancel an existing payment request
      • Get a Payment
      • Get many Payments
  • Payouts
    • Get a Payout
      GET
    • Get Available Payouts
      GET
  • Webhooks
    • Mandate Created/Updated
    • Payment Request Created/Updated
    • Payout Created
  1. Payouts

Get Available Payouts

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
/payouts
Get all of the available payouts made between two dates.

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
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/payouts?start_date=2024-12-28&end_date=2025-11-23&start_index=0&limit=50' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "results": {
        "payouts": [
            {
                "payout_reference": "stringst",
                "created_date": "2019-08-24T14:15:22Z"
            }
        ],
        "paging": {
            "start_index": 0,
            "count": 0,
            "previous_page": "/search?start_index=0&limit=50",
            "next_page": "/search?start_index=51&limit=50"
        }
    }
}
Previous
Get a Payout
Next
Webhooks