Get Pay Plan Eligibility Max Amount

Get customer eligibility maximum loan amount

SecurityLimepay-PublicKey
Request
Request Body schema: application/json
customerId
required
string

The Limepay unique identifier for the customer

PayPlan_10_Monthly_Payments (object) or PayPlan_11_Monthly_Payments (object) or PayPlan_12_Monthly_Payments (object) or PayPlan_26_Fortnightly_Payments (object) or PayPlan_2_Monthly_Payments (object) or PayPlan_30_Days_0_100 (object) or PayPlan_3_Monthly_Payments (object) or PayPlan_4_Monthly_Payments (object) or PayPlan_4_Week_0_100 (object) or PayPlan_4_Weekly_Payments (object) or PayPlan_52_Weekly_Payments (object) or PayPlan_5_Monthly_Payments (object) or PayPlan_6_Monthly_Payments (object) or PayPlan_7_Monthly_Payments (object) or PayPlan_7_Week_0_100 (object) or PayPlan_8_Monthly_Payments (object) or PayPlan_8_Weekly_Payments (object) or PayPlan_9_Monthly_Payments (object) or PayPlan_Fortnight_0_100 (object) or PayPlan_Fortnight_25_25_25_25 (object) (PayPlanVariant)

The pay plan variant to be used - defaults to the first configured value for the merchant or payplan_fortnight_25_25_25_25

Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/payments/plan/eligibility-max
Request samples
application/json
{
  • "customerId": "cust_Zd_ZZn1Yk3zGJoyC",
  • "payPlanVariant": { }
}
Response samples
application/json
{
  • "maxLoanAmount": 0,
  • "currency": "AUD",
  • "summary": "string"
}
Copyright © April Solutions 2023. All right reserved.