Pluggy

Pluggy Payment Schedule API

Payment scheduling operations

Documentation GitHub OpenAPI

Operations 3

GET /payments/requests/{id}/schedules List Schedules #

POST /payments/requests/{id}/schedules/cancel Cancel Payment Schedule Authorization #

POST /payments/requests/{id}/schedules/{scheduleId}/cancel Cancel Payment Schedule #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/pluggy:pluggy-payment-schedule-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Pluggy Payment Schedule API
  description: Pluggy's main API to review data and execute connectors
  license:
    name: MIT
  contact:
    email: hello@pluggy.ai
    name: Pluggy
    url: https://pluggy.ai
  version: 1.0.0
servers:
- url: https://api.pluggy.ai
  description: Pluggy API
tags:
- name: Payment Schedule
  description: Payment scheduling operations
paths:
  /payments/requests/{id}/schedules:
    get:
      operationId: payment-schedules-list
      summary: List Schedules
      description: Recovers all scheduled payments from a payment request
      responses:
        '200':
          description: Retrieve a list of all scheduled payments
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: number
                    format: double
                    description: ''
                  total:
                    type: number
                    format: double
                    description: ''
                  totalPages:
                    type: number
                    format: double
                    description: ''
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/SchedulePayment'
                    description: List of scheduled payments from a payment request
              examples:
                response:
                  value:
                    page: 1
                    total: 2
                    totalPages: 1
                    results:
                    - id: 05c693bf-c196-47ea-a28c-8251d6bb8a04
                      scheduledDate: '2024-05-04'
                      description: PAGAMENTO AGENDADO 1/3
                      status: ERROR
                      errorDetail:
                        code: INSUFFICIENT_BALANCE
                        description: The account doesn't have enough balance to perform the payment.
                        detail: A conta selecionada não possui saldo suficiente para realizar o pagamento.
                    - id: 05c693bf-c196-47ea-a28c-8251d6bb8a05
                      scheduledDate: '2024-06-04'
                      description: PAGAMENTO AGENDADO 2/3
                      status: COMPLETED
                      errorDetail: null
                      endToEndId: E44471172202505141500U29c6ff88e3
                    - id: 05c693bf-c196-47ea-a28c-8251d6bb8a06
                      scheduledDate: '2024-07-04'
                      description: PAGAMENTO AGENDADO 3/3
                      status: SCHEDULED
                      errorDetail: null
      parameters:
      - description: Payment request primary identifier
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        example: d0e8a7f0-6d86-11ea-b77f-2e728ce88125
      tags:
      - Payment Schedule
      security:
      - default: []
  /payments/requests/{id}/schedules/cancel:
    post:
      operationId: payment-schedules-cancel
      summary: Cancel Payment Schedule Authorization
      description: ''
      responses:
        '204':
          description: No content
      parameters:
      - description: Payment request primary identifier
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        example: d0e8a7f0-6d86-11ea-b77f-2e728ce88125
      tags:
      - Payment Schedule
      security:
      - default: []
  /payments/requests/{id}/schedules/{scheduleId}/cancel:
    post:
      operationId: payment-schedules-cancel-specific
      summary: Cancel Payment Schedule
      description: ''
      responses:
        '204':
          description: No content
      parameters:
      - description: Payment request primary identifier
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        example: d0e8a7f0-6d86-11ea-b77f-2e728ce88125
      - description: Payment schedule primary identifier
        in: path
        name: scheduleId
        required: true
        schema:
          type: string
          format: uuid
        example: d0e8a7f0-6d86-11ea-b77f-2e728ce88125
      tags:
      - Payment Schedule
      security:
      - default: []
components:
  schemas:
    SchedulePayment:
      description: Information of a schedule payment
      properties:
        id:
          type: string
          format: uuid
        description:
          type: string
          description: Scheduled payment description
        status:
          type: string
          description: Scheduled payment status
          enum:
          - SCHEDULED
          - COMPLETED
          - ERROR
        scheduledDate:
          type: string
          format: date
          description: Date when the payment is scheduled
        endToEndId:
          type: string
          description: Identifier for the payment, used to link the scheduled payment with the corresponding payment received
        errorDetail:
          type:
          - object
          - 'null'
          description: Details about an error that occurred with the scheduled payment
          properties:
            code:
              type: string
              description: Error code
            description:
              type: string
              description: Human-readable description of the error
            detail:
              type: string
              description: Additional details about the error in the provider's language
      type: object
      required:
      - id
      - description
      - status
      - scheduledDate
  securitySchemes:
    default:
      type: apiKey
      name: X-API-KEY
      in: header
x-provenance:
  method: harvested
  publisher: Pluggy
  source: https://v2.docs.pluggy.ai/openapi/pluggy-api.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)