Calculate Pay Plan Parameters

Calculate the pay plan parameters for the given amount and list of variants.

Beta release - This endpoint is close to being finalised but non-backward compatible changes to parameters and behaviour may still occur.

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

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

Request Body schema: application/json
required
required
object (CurrencyAmount)

The full order amount

payPlanVariants
Array of strings (PayPlanVariant)

The variants of the plan to calculate parameters for.

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"
payInFullAmount
integer <int64>

The portion of the order amount that is for pay in full items in minor currency units. Only relevant for merchants who have a pre-arranged agreement with April to support orders including some pay in full items.

Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/payplans/parameters
Request samples
application/json
{
  • "amount": {
    },
  • "payPlanVariants": [
    ],
  • "payInFullAmount": 0
}
Response samples
application/json
{
  • "parameters": [
    ]
}
Copyright © April Solutions 2023. All right reserved.