v1
latestOpenAPI 3.0.02026-07-2412592575.3 KBpayments
Retrieve all recurring payments created by an API client
Requires recurring-payment:read scope.
get/recurring-payments
Query parameters
limitinteger
The total number of records to retrieve
offsetinteger
The offset at which to start retrieving records
userIdstring
The ID of the user to filter transactions on
Response
Successful Recurring Payment Response
Example response
{
"data": [
{
"id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
"createdAt": "2020-07-10T12:00:00+00:00",
"updatedAt": "2020-07-10T12:00:00+00:00",
"revokedAt": "2020-07-10T12:00:00+00:00",
"recurringPayment": {
"validFromDate": "2020-12-02T00:00:00.000Z",
"validToDate": "2021-01-02T00:00:00.000Z",
"maximumIndividualAmount": 2000,
"currency": "GBP",
"periodicLimits": [
{
"amount": 100,
"currency": "GBP"
}
]
}
}
]
}