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. |
| status |
ACTIVE DELINQUENT DELETED COMPLETED PAUSED |
Use the status as a filter. No filter is ALL - Note DELINQUENT schedules are also ACTIVE so you will see the DELINQUENT schedules when you use the ACTIVE filter |
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
API version 2023-05-16 or above required to receive the surcharge object and fields in transaction response details. See how to use API versions here.
The surcharge object is only present if surcharge is enabled on the account.
Click here for more information regarding surcharge.
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": "10.00",
"amountSurcharge": "0.30",
"amountTotal": "10.30",
"surcharge" : {
"percentage" : 3.00000,
"status" : "APPLIED"
},
"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"
} ]
}