{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/Mandate", "title": "Mandate", "properties": { "amount": { "description": "The billing amount (in minor units) of the recurring transactions.", "type": "string" }, "amountRule": { "description": "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", "enum": [ "max", "exact" ], "type": "string" }, "billingAttemptsRule": { "description": "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", "enum": [ "on", "before", "after" ], "type": "string" }, "billingDay": { "description": "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", "type": "string" }, "endsAt": { "description": "End date of the billing plan, in YYYY-MM-DD format.", "type": "string" }, "frequency": { "description": "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", "enum": [ "adhoc", "daily", "weekly", "biWeekly", "monthly", "quarterly", "halfYearly", "yearly" ], "type": "string" }, "remarks": { "description": "The message shown by UPI to the shopper on the approval screen.", "type": "string" }, "startsAt": { "description": "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", "type": "string" } }, "required": [ "frequency", "amount", "endsAt" ], "type": "object" }