PluggyDocs
GET/payments/requests/{id}/schedules

List Schedules

Recovers all scheduled payments from a payment request

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Retrieve a list of all scheduled payments
object
pagenumber (double)
totalnumber (double)
totalPagesnumber (double)
resultsobject[]

List of scheduled payments from a payment request

itemsobject

Information of a schedule payment

Example response

json
{
  "page": 0,
  "total": 0,
  "totalPages": 0,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "description": "string",
      "status": "SCHEDULED",
      "scheduledDate": "2024-01-01",
      "endToEndId": "string",
      "errorDetail": {
        "code": "string",
        "description": "string",
        "detail": "string"
      }
    }
  ]
}

Code Examples

bash
curl -X GET 'https://api.pluggy.ai/payments/requests/{id}/schedules' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Try It

Path Parameters