Return a paginated list of matching pay plans.
Matching items sorted as specified
[- {
- "payPlanId": "plan_Zv9NycMUtVSrz92y",
- "merchantId": "mcht_Zv9NycMUtVSrz92w",
- "customerId": "cust_Zv9NycMUtVSrz92x",
- "state": "Created",
- "amount": {
- "minorCurrencyUnits": 0,
- "currency": "AUD"
}, - "surchargeAmount": 0,
- "platformFee": 0,
- "taxAmount": 0,
- "payPlanVariant": "payplan_fortnight_25_25_25_25",
- "nextInstalmentDate": "2019-08-24T14:15:22Z",
- "nextInstalment": 3,
- "planAmountOutstanding": 0,
- "paymentSourceType": "Card",
- "merchantOrderId": "ordr_Zv9NycMUtVSrz920",
- "transactionId": "tran_Zv9NycMUtVSrz92z",
- "charges": [
- {
- "chargeId": "chrg_Zv9NycMUtVSrz921",
- "amount": 0,
- "isSuccess": true,
- "instalmentNumber": 0,
- "instalmentCharge": true,
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "refunds": [
- {
- "refundId": "rfnd_Zv9Ny8MUtVSrz93C",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "isRefunded": true,
- "isOverdue": true,
- "overdueAmount": 0,
- "overdueAt": "2019-08-24T14:15:22Z",
- "bankTransferDetails": {
- "reference": "string",
- "bankAccountNumber": "string",
- "bankAccountBsb": "string",
- "payId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]