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.
{- "amount": {
- "minorCurrencyUnits": 0,
- "currency": "AUD"
}, - "initialPayment": 0,
- "payPlanVariant": "payplan_fortnight_25_25_25_25",
- "metadata": { }
}
{- "offerDetails": {
- "merchantId": "mcht_ZtqZhJAAVEu0G0pf",
- "customerId": "cust_ZtqZhJAAVEu0G0pg",
- "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"
}