get https://api.gliderpay.com/glider/report/v1/instalment.json/startDate//endDate/
Given a date range (start and end date time) returns the list of all the payment plans that have been saved.
This API will return tokenised credit / debit card or bank details information to be used to set up a payment plan on your payment gateway portal.
Start and end date must be in the following format YYYY-MM-DD and they will be compared with the payment plan creation time. All dates are in UTC timezone.
| Parameter | Description | Example |
|---|---|---|
| startDate | Initial date where the query will start | 2020-10-10 |
| endDate | Final date where the query will end | 2020-11-11 |
- Parameters
- startDate (required, string,
2020-10-10) ... start date YYYY-MM-DD format. - endDate (required, string,
2020-10-20) ... end date YYYY-MM-DD format.
- startDate (required, string,
/ instalment.json / {dateRange} [GET]
Api response contains the total number of record and the details of each transaction in the following format
{
count: 2
data [ ... ]
}
Described below are the instalment object details:
| Name | Description | Example |
|---|---|---|
| id | Payment Plan unique identifier | 1 |
| invoiceId | Invoice unique identifier | 30328 |
| startDate | Plan starting date | 2020-09-03 00:00:00 |
| frequency | Plan frequency | weekly |
| frequencyValue | Plan frequency value (e.g.: value-unit) | 7-days |
| amount | Instalment amount | 20 |
| lastAmount | Last instalment amount | 3 |
| totalAmount | Total invoice amount | 1823 |
| noOfInstalments | No. of instalments | 92 |
| paymentMethod | Plan payment method (bank or card) | card |
| ccHolderName | Credit / Debit Card holder name | John Doe |
| ccType | Credit / Debit Card issuer | Visa |
| ccTokenised | Credit / Debit Card Token number | 9657838309933158 |
| ccMasked | Credit / Debit Card masked number | 424242******4242 |
| ccExpM | Credit / Debit Card Month expiry time | 10 |
| ccExpY | Credit / Debit Card Year expiry time | 2020 |
| bankAccountName | Direct Debit account name | John Doe |
| bankBsb | Direct Debit BSB | 084324 |
| bankAccountNumber | Direct Debit account number | 123456 |
| paymentMethodDetails | Additinoal payment method details | `` |
| planRate | Interest Rate | 3.5 |
| planMaxTerm | Plan Max term (in years) | 5 |
| paypalPayerID | Paypal payer ID | 15654695 |
| paypalTokenised | Paypal payer topkenised payment method | abcdef1234567890 |
| paypalFirstName | Paypal payer first name | Ryu |
| paypalLastName | Paypal payer last name | Jordan |
| paypalEmail | Paypal payer email address | [email protected] |
| created | Payment Plan creation time | 2022-09-02 07:22:26 |
| updated | Payment Plan update time | 2022-09-02 07:22:26 |
| accountName | Invoice account name | Ryu Jordan |
| accountNumber | Invoice account number | SCJ123456 |
| contact | Invoice contact details | +61432558411 |