To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Registration that marks an app as a payment provider, holding the function names and payment form it offers to shopping carts. Produced by the payment provider details builder and stored on the app's controller mappings. The process function handles a one off payment; the recurring pair sets up and then takes subsequent scheduled payments; the payment options are the branded choices shown at checkout.
Group: App Definitions
Properties
| Property | Returns | Description |
|---|---|---|
| initRecurringFn | String | Name of the function called after the first payment to set up the recurring transaction with the payment gateway. |
| makeTokenPaymentFn | String | Name of the function called for each subsequent scheduled payment, using the token stored when the recurring transaction was set up. |
| paymentForm | String | Repository path of the template that renders this provider's payment form at checkout. |
| paymentOptions | List<PaymentOptionBean> | Branded payment options this provider offers at checkout, each with an id, title and logo. The list is immutable. |
| processFn | String | Name of the function that takes a single one off payment. It is called with the payment result, the cart, the total amount, the form context, the purchaser, the recurring amount, the repeat multiples and the repeat units. An implementation may set up the recurring parts here rather than in the initialise recurring function. |
Methods
getProcessFn()
Returns: String
Name of the function that takes a single one off payment. It is called with the payment result, the cart, the total amount, the form context, the purchaser, the recurring amount, the repeat multiples and the repeat units. An implementation may set up the recurring parts here rather than in the initialise recurring function.
getInitRecurringFn()
Returns: String
Name of the function called after the first payment to set up the recurring transaction with the payment gateway.
getMakeTokenPaymentFn()
Returns: String
Name of the function called for each subsequent scheduled payment, using the token stored when the recurring transaction was set up.
getPaymentForm()
Returns: String
Repository path of the template that renders this provider's payment form at checkout.
getPaymentOptions()
Returns: List<PaymentOptionBean>
Branded payment options this provider offers at checkout, each with an id, title and logo. The list is immutable.
© 2025 Kademi Ltd