GET /schedules?{query-parameters}

The following is a BETA API and is subject to change.

If you are interested in integrating Schedules, please reach out to our Support team at support@payjunction.com or submit a ticket through our Developer Support request form for more information about our beta program.

Search for previously created schedules based on supplied parameters.

Paging Parameters

name format description
limit Max 50 Limits the number of results per page.
See Pagination.
offset Max 2^31 The index at which to start returning results.
See Pagination.

Example Request

curl https://api.payjunction.com/schedules?limit=1 \
  -u "login:password" \
  -H "Accept: application/json" \
  -H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY"

Response

Successful Search Response

{
	"next" : "https://api.payjunction.com/schedules?offset=1&limit=1",
	"results" : [ {
		"scheduleId" : 1053,
		"terminalId" : 51,
		"scheduleType" : "PERIODIC",
		"interval" : "MONTH",
		"intervalCount" : 1,
		"amountBase" : "5.00",
		"amountTotal" : "5.00",
		"vault" : {
			"accountType" : "VISA",
			"lastFour" : "1111",
			"type" : "CARD"
		},
		"billing" : {
			"firstName" : "Jane",
			"lastName" : "Doe"
		},
		"status" : "ACTIVE",
		"startDate" : "2021-08-18",
		"created" : "2021-08-16T22:14:10Z",
		"lastModified" : "2021-08-17T16:25:37Z",
		"nextTransaction" : "2021-08-18"
	} ]
}