GET/payments/requests/{id}/schedules

Listar Agendas

Recupera todos os pagamentos agendados de uma solicitação de pagamento

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário da solicitação de pagamento

Responses

200Recupere uma lista de todos os pagamentos agendados

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"
      }
    }
  ]
}

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

Resposta de exemplo

{
  "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"
      }
    }
  ]
}