Money In

Electronic Mandates

Hosted web pages that new customers can use to signup with or existing customers can use to add collections to their account.

Admins can create these hosted pages under the 'Get Paid' section. This API provides a list of the Electronic Mandates and generates links to be shared with new/existing customers for new collections.

List

List Electronic Mandates loaded on the platform.

Path

GET /electronic-mandates/list

Response Body

{
  "status": true,
  "results": [{
    "id": "pag_q5lJ554cUsptaXbDDb7sG",
    "view": "https://app.kwik.co.za/electronic-mandate/<unique-id>",
    "title": "Diamond package",
    "description": "Lorem ipsum",
    "page_status": "PUBLISHED",
    "payment_methods_id": "pam_9b_DTCrtPblUgNHodKAxB",
    "payment_type": "emandate_choose_what_to_pay"
  }, ...]
}

Response Parameters

Field	Type	Description	Example
id	String(32)	Electronic Mandate page id	pag_q5lJ554cUsptaXbDDb7sG
view	Text	Link for new customer sign ups	`https://app.kwik.co.za/electronic-mandate/<unique-id>`
title	String(128)	Electronic Mandate title	Diamond package
description	Text	Electronic Mandate description	Lorem ipsum
page_status	ENUM	(`PUBLISHED`,`DRAFT`,`DISABLED`,`ARCHIVED`)	PUBLISHED
payment_methods_id	String(32)	ID of the payment method used with this Electronic Mandate	pam_9b_DTCrtPblUgNHodKAxB
payment_type	String(64)	Type of payment the Electronic Mandate represents. (`emandate_products_and_collections`, `emandate_choose_what_to_pay`)	emandate_choose_what_to_pay

Generate Link

Generate a unique, shareable mandate link. You can optionally supply a customer ID, bank account ID, and/or amount; the returned link opens a mandate prefilled with whichever of those you pass.

Path

POST /electronic-mandates/link

Request Body

{
  "records": [{
    "page_id": "pag_q5lJ554cUsptaXbDDb7sG",
    "customer_id": "cus_q0lJckGcUQptaXODDb7sG",
    "bank_account_id": "ban_xrf4nxBPH5bwjXIrl6Le5",
    "amount": 300.00
  }]
}

Request Parameters

Field	Required	Type	Description	Example
page_id	Y	String(32)	Electronic Mandate Page ID to generate a link for	pag_q5lJ554cUsptaXbDDb7sG
customer_id	N	String(32)	Existing Customer ID	cus_q0lJckGcUQptaXODDb7sG
bank_account_id	N	String(32)	Existing Bank Account ID	ban_xrf4nxBPH5bwjXIrl6Le5
amount	N	Decimal	Used with 'own amount' pages (pages where customers are allowed to manually type any amount in). It will preset the amount on the page and disable the input.	300.00

Response Body

{
  "status": true,
  "results": [{
    "page_id": "pag_q5lJ554cUsptaXbDDb7sG",
    "link": "https://app.kwik.co.za/electronic-mandate/<unique-id>"
  }, ...]
}

Response Parameters

Field	Type	Description	Example
page_id	String(32)	Page related to the link	pag_q5lJ554cUsptaXbDDb7sG
link	Text	Link to be shared with the customer	`https://app.kwik.co.za/electronic-mandate/<unique-id>`

Checkout Form

Create a secure, customizable checkout form session to capture payments with cards, bank transfers, and other payment methods. Supports 3D Secure authentication, cards storage for recurring billing, invoice issuance, customer creation, and webhook notifications.

Collections

Process one-time and recurring collections across multiple methods including EFT Debit Orders, DebiCheck and Registered Mandates. Handle collection creation, status tracking, refunds, and webhook notifications.