Create Pay Plan Offer

Create a pay plan offer for a registered and KYC'd merchant customer. The offer returned must be used to create a pay plan within 10 minutes. After this point, generate a new offer by calling this endpoint again.

If called with a customer JWT, the pay plan is created for that customer, otherwise the customer must be provided via the Customer-Id request header.

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

required	object (CurrencyAmount) The full plan amount
initialPayment	integer <int64> An optional amount that the customer will pay up front in minor currency units (e.g. cents for AUD)
payPlanVariant required	string (PayPlanVariant) The variant of the plan to construct. This implies the number of instalments; the minimum initialPayment expected; and the frequency of payments (e.g. fortnightly, weekly, etc.) 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"
metadata	object (JsonObject) An optional data structure including additional customer data that could influence the offer outcome. Only used if agreed up front between the payment system and the merchant. Independent from metadata provided during order creation.

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/payplans/offer

Request samples

Payload
Curl
JavaScript

application/json

{"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"initialPayment": 0,
"payPlanVariant": "payplan_fortnight_25_25_25_25",
"metadata": { }
}

Response samples

application/json

{"offerDetails": {"merchantId": "mcht_Z2OSz5JDfRbNb_SY",
"customerId": "cust_Z2OSz5JDfRbNb_SZ",
"isCounterOffer": true,
"threeDSecureRequired": true,
"payPlanParameters": {"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"initialPayment": 0,
"instalmentLength": 0,
"instalmentFrequency": "Weekly",
"proposedSchedule": [{"at": "2019-08-24T14:15:22Z",
"amount": 0
}
],
"payPlanVariant": "payplan_fortnight_25_25_25_25"
},
"createdAt": "2019-08-24T14:15:22Z"
},
"offerVerificationToken": "string",
"message": "string"
}