Query Pay Plans

Return a paginated list of matching pay plans.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
customerId	Array of strings Filter by customer identifier
merchantId	Array of strings Filter by merchant identifier
payPlanState	Array of strings (PayPlanState) Filter by pay plan state Items Enum: "Created" "Active" "Completed" "InDefault"
payPlanVariant	Array of strings (PayPlanVariant) Filter by pay plan variant Items Enum: "payplan_fortnight_25_25_25_25" "payplan_4_weekly_payments" "payplan_8_weekly_payments" "payplan_26_fortnightly_payments" "payplan_52_weekly_payments" "payplan_2_monthly_payments" "payplan_3_monthly_payments" "payplan_4_monthly_payments" "payplan_5_monthly_payments" "payplan_6_monthly_payments" "payplan_7_monthly_payments" "payplan_8_monthly_payments" "payplan_9_monthly_payments" "payplan_10_monthly_payments" "payplan_11_monthly_payments" "payplan_12_monthly_payments" "payplan_fortnight_0_100" "payplan_4_week_0_100" "payplan_7_week_0_100" "payplan_30_days_0_100"

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/payplans

Request samples

Curl
JavaScript

Response samples

application/json

[{"payPlanId": "plan_Z2icv3UXMhzzOEVj",
"merchantId": "mcht_Z2icvnUXMhzzOEVh",
"customerId": "cust_Z2icvnUXMhzzOEVi",
"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_Z2icv3UXMhzzOEVl",
"transactionId": "tran_Z2icv3UXMhzzOEVk",
"charges": [{"chargeId": "chrg_Z2icv3UXMhzzOEVm",
"amount": 0,
"isSuccess": true,
"instalmentNumber": 0,
"instalmentCharge": true,
"createdAt": "2019-08-24T14:15:22Z"
}
],
"refunds": [{"refundId": "rfnd_Z2icwHUXMhzzOEV0",
"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"
}
]