Calculate Pay Plan Max Loan

Return the maximum loan amount the given customer is currently eligible for.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT
Request
header Parameters
Customer-Id
string

Perform operation in the context of the given merchant customer. Usually not required — specify only if acting on behalf of a merchant customer not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
required
currency
required
string

Currency to request max loan amount for

payPlanVariant
string (PayPlanVariant)

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

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
400
401
403
404
405
406
409
422
429
500
503
post/payplans/max
Request samples
application/json
{
  • "currency": "AUD",
  • "payPlanVariant": "payplan_fortnight_25_25_25_25"
}
Response samples
application/json
{
  • "amount": {
    },
  • "summary": "string"
}
Copyright © April Solutions 2023. All right reserved.