/v1/payment-schedules/{id}/paymentsThe instalments under one schedule
Every instalment on one schedule, in payment-number order: what is due, when, what actually landed, the variance, any penalty, and the state each one is in (scheduled, pending, processing, completed, partial, failed, missed, waived, reversed). ?limit= caps the page (500 by default, 1000 max). This is the schedule's own run; for what is due across the WHOLE book reach for get_payments_overdue or get_payments_upcoming, and for the Payments board as a page read get_definitions_key_rows with key payments.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": [
{
"achTraceNumber": "string",
"actualAmountMinor": 1,
"balanceAfterMinor": 1,
"balanceBeforeMinor": 1,
"batchId": "",
"cashFlowId": 1,
"counterpartyId": 1,
"createdAt": "string",
"currency": "string",
"detail": {},
"dueDate": "string",
"expectedAmountMinor": 1,
"externalTransactionId": "",
"facilityId": 1,
"failedAt": "string",
"failureCode": "string",
"failureReason": "string",
"gracePeriodEnd": "string",
"id": 1,
"maxRetries": 1,
"method": "string",
"nextRetryDate": "string",
"notes": "string",
"paymentNumber": 1,
"penaltyAmountMinor": 1,
"processedAt": "string",
"reconciled": true,
"reconciledAt": "string",
"reconciledByUserId": 1,
"reconciliationNotes": "string",
"referenceNumber": "string",
"retryCount": 1,
"reversedAt": "string",
"scheduleId": 1,
"settledAt": "string",
"status": "string",
"updatedAt": "string",
"varianceMinor": 1,
"waivedAt": "string"
}
]
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}