---
title: "Get Upcoming Payout Amount and Schedule"
method: GET
path: "/v1/merchants/{id}/schedules"
---

# Get Upcoming Payout Amount and Schedule

`GET /v1/merchants/{id}/schedules`

## Request

- Base URL: `https://api.paymongo.com`
- URL: `https://api.paymongo.com/v1/merchants/{id}/schedules`
- Auth: HTTP basic

Get upcoming payout amount and schedule for a specific merchant by its ID.

## Path parameters

- `id` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `id` string: The merchant's ID
    - `type` string: The type of the resource
    - `attributes` object
      - `options` string[]: Available payout schedule options
      - `type` string: The current payout schedule type
      - `days` string: The day(s) of name for weekly schedule or the date of monthly schedule
      - `lineup` object[]: Upcoming payouts in order
        - `amount` integer: The upcoming payout amount
        - `currency` string: The currency code
        - `transactions` object: Breakdown of transaction types
          - `adjustments` object
            - `amount` integer: Total adjustments amount
            - `count` integer: Number of adjustments
            - `currency` string: Currency code
          - `disputes` object
            - `amount` integer: Total disputes amount
            - `count` integer: Number of disputes
            - `currency` string: Currency code
          - `payments` object
            - `amount` integer: Total payments amount
            - `count` integer: Number of payments
            - `currency` string: Currency code
          - `refunds` object
            - `amount` integer: Total refunds amount
            - `count` integer: Number of refunds
            - `currency` string: Currency code
        - `generation_at` integer: Unix timestamp when the upcoming payout will be generated
        - `receive_at` integer: Unix timestamp when the upcoming payout will be received

---

[API](https://skmtc.dev/paymongo/apis/payouts-api.md) - [All operations](https://skmtc.dev/paymongo/apis/payouts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/payouts-api/revisions/1161da1077b5?raw)