Step 1: Initialize mandate

Step 1: Initialize e-mandate with the payer

POST: https://api.creditchek.africa/v1/recova/recova/consent/create

Sample request account_number: 12345678901 and 09876543212

Contact [email protected] if you encounter any error responses at this stage.

Request Parameters

Sample request

{
  "productId": "668fc0b1df7fd723bf201664", // required
  "bvn": "12345678901", //required
  "frequency": "monthly", // required ('daily', 'weekly', 'monthly')
  "startDate": "2024-07-07", // required
  "endDate": "2024-10-31", // required
  "totalAmountDue": 15000, // required
  "collectionMode": "auto", // required ('manual', 'auto')
  "debitType": "recurring", // required ('recurring', 'oneTime')
  "mandateType": "variable", // required ('fixed', 'variable')
  "corporateAccount": false, // Required [boolean (true/false)]
  "balanceEnquiry": false, // Required
  "rcNumber": "98786888", // (only required when "corporateAccount" is true)
  "businessName": "CREDITCHEK TECHNOLOGIES LIMITED", //(only required when corporateAccount is true)
  "businessEmail": "[email protected]", //(only required when "corporateAccount" is true)
  "businessPhone": "08111221122", //(only required when "corporateAccount" is true)
  "debitDate": "2024-04-24", // optional
  "firstRepaymentPercentage": 20, // optional min(1)|max(100)
};

Response

{
  "status": true,
  "data": {
    "businessId": "730c8be89121212121212121",
    "borrowerId": null,
    "appId": "730c8be89131cd1111111111",
    "reference": "563315af-f0a4-420f-8e5e-df9b1c28973b",
    "productId": "768fc9999999999999999999",
    "bvn": "12345678901",
    "startDate": "2024-07-07",
    "endDate": "2024-10-31",
    "frequency": "monthly",
    "totalAmountDue": 15000,
    "collectionMode": "auto",
    "rcNumber": null,
    "corporateAccount": false,
    "businessName": null,
    "businessEmail": null,
    "businessPhone": null,
    "debitType": "recurring",
    "mandateType": "variable",
    "status": "pending",
    "balanceEnquiry": false,
    "creditInsurance": false,
    "consents": [],
    "acceptedTerms": true,
    "isDemo": true,
    "_id": "77192739b3cf770000000000",
    "createdAt": "2024-10-23T16:41:29.085Z",
    "updatedAt": "2024-10-23T16:41:29.085Z",
    "__v": 0,
    "outstandingBalance": 15000,
    "collectedAmount": 0,
    "authorizationType": "e-signature"
  },
  "message": "consent created successfully",
  "error": false
}