Skip to main content
GET
/
api
/
v1
/
schedules
/
{schedule_id}
/
payments
List schedule payments
curl --request GET \
  --url https://api.config.money/api/v1/schedules/{schedule_id}/payments \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "schedule_id": "<string>",
      "amount": {
        "value": 123,
        "currency": "<string>"
      },
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "failure_reason": "<string>"
    }
  ],
  "total": 123
}

​
List Schedule Payments

Retrieve all payments associated with a specific collection schedule.
This endpoint requires API key authentication. Include your API key in the Authorization header.

​
Endpoint

GET /api/v1/schedules/{schedule_id}/payments

​
Headers

NameTypeDescription
AuthorizationstringYour API key in the format Bearer YOUR_API_KEY

​
Path Parameters

ParameterTypeDescription
schedule_idstringID of the schedule

​
Query Parameters

ParameterTypeDescription
limitintegerNumber of records to return (default: 10, max: 100)
offsetintegerNumber of records to skip (default: 0)

​
Response

​
Success Response (200 OK)

{
  "data": [
    {
      "id": "pay_123456789",
      "schedule_id": "sched_123456789",
      "amount": {
        "value": 2000,
        "currency": "GBP"
      },
      "status": "completed",
      "created_at": "2024-03-01T10:00:00Z",
      "completed_at": "2024-03-01T10:01:00Z"
    },
    {
      "id": "pay_987654321",
      "schedule_id": "sched_123456789",
      "amount": {
        "value": 2000,
        "currency": "GBP"
      },
      "status": "failed",
      "created_at": "2024-02-01T10:00:00Z",
      "failed_at": "2024-02-01T10:01:00Z",
      "failure_reason": "Insufficient funds in customer account"
    }
  ],
  "total": 2
}

​
Error Responses

​
401 Unauthorized

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}

​
404 Not Found

{
  "error": {
    "code": "not_found",
    "message": "Schedule not found"
  }
}

​
429 Too Many Requests

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests"
  }
}

​
Examples

​
List All Payments for a Schedule

curl -X GET https://api.config.money/api/v1/schedules/sched_123456789/payments \
  -H "Authorization: Bearer YOUR_API_KEY"

​
List Payments with Pagination

curl -X GET "https://api.config.money/api/v1/schedules/sched_123456789/payments?limit=20&offset=40" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authorizations

​
Authorization
string
header
required

API key in the format 'Bearer YOUR_API_KEY'

Path Parameters

​
schedule_id
string
required

ID of the schedule

Query Parameters

​
limit
integer
default:10

Number of records to return

​
offset
integer
default:0

Number of records to skip

Response

200 - application/json

List of payments

​
data
object[]
​
total
integer