Skip to main content
GET
List scheduled payments

Headers

x-api-key
string
required
Example:

"your-x-api-key"

x-api-token
string
required
Example:

"your-x-api-token"

Query Parameters

status
enum<string>

Filter by payment status.

Available options:
PENDING_SCHEDULE,
SCHEDULED,
PAID,
FAILED,
CANCELLED
Example:

"PAID"

initialDueDate
string<date>

Filter by start due date.

Example:

"2025-01-01"

finalDueDate
string<date>

Filter by end due date.

Example:

"2025-12-31"

page
integer
default:0

Page number for the query.

maxPageResults
integer
default:20

Maximum number of results per page.

sortBy
enum<string>
default:creation

Field to sort the results by.

Available options:
dueDate,
creation
order
enum<string>
default:DESC

Sort order.

Available options:
ASC,
DESC

Response

List of scheduled payments returned successfully.

status
integer
message
string
totalElements
integer
totalPages
integer
resultSize
integer
results
object[]