Manual collection

Initiate manual e-mandate debit for payer

PUT: https://api.creditchek.africa/v1/recova/consent/business/manual/activate

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

For mandates created with collectionMode: "manual", trigger an on-demand debit against the approved mandate.

PUT /v1/recova/consent/business/manual/activate
Content-Type: application/json
token: <YOUR_API_KEY>

{
  "mandateId": "66f1b8c4d29a430018a99101",
  "amount": 20000,
  "debitDate": "2026-10-15"
}

Response (200 OK)

{
  "status": true,
  "message": "Manual mandate debit scheduled successfully",
  "error": false,
  "data": {
    "mandateId": "66f1b8c4d29a430018a99101",
    "totalAmount": 20000,
    "outstandingBalance": 20000,
    "transactionRefence": "bec06990-36f0-4d93-8544-9dae351e8eaf",
    "paymentStatus": "pending",
    "dueDate": "2026-10-15T00:00:00.000Z"
  }
}

---

Collection Logs & Reporting

RecovaPRO provides authenticated reporting and audit endpoints to inspect collection attempts, debit logs, and transaction outcomes across your mandates and individual installments.

---

Get Collection Log by Mandate ID

Retrieves the collection log for a given mandate, detailing overall collection type, amounts, and execution statuses.

GET /v1/recova/consent/business/collection-log?mandateId=66f1b8c4d29a430018a99101
token: <YOUR_API_KEY>

Query Parameters

Parameter	Type	Required?	Description
mandateId	string	Yes	24-character hexadecimal Database Key Identifier _id of the mandate.

Response (200 OK)

{
  "status": true,
  "message": "Mandate collection log retrieved successfully",
  "error": false,
  "data": {
    "_id": "670fd1234a9b2c0018d99001",
    "businessId": "630c8be89131cd442344e790",
    "mandateId": "66f1b8c4d29a430018a99101",
    "consentId": "66f1b9f1d29a430018a99105",
    "collectionType": "auto",
    "status": "successful",
    "amount": 20000,
    "transactionRefence": "bec06990-36f0-4d93-8544-9dae351e8eaf",
    "createdAt": "2026-10-15T02:00:15.000Z"
  }
}

---

Get Collection Logs by Installment

Resolves an individual repayment breakdown item to its internal transactionRefence and returns all matching collection attempts and debit logs in reverse chronological order. This allows you to inspect retries, bank decline codes, and cascade attempts for a specific installment.

GET /v1/recova/consent/business/collection-log/installment?mandateId=66f1b8c4d29a430018a99101&breakdownId=66f1b8c4d29a430018a99110
token: <YOUR_API_KEY>

Query Parameters

Parameter	Type	Required?	Description
mandateId	string	Yes	The mandate _id.
breakdownId	string	Yes	The _id of the specific installment item in the mandate's repaymentDetails breakdown.

Response (200 OK)

{
  "status": true,
  "message": "Collection attempts retrieved successfully",
  "error": false,
  "data": [
    {
      "_id": "670fd1234a9b2c0018d99002",
      "mandateId": "66f1b8c4d29a430018a99101",
      "instalmentReference": "bec06990-36f0-4d93-8544-9dae351e8eaf",
      "accountNumber": "0088741090",
      "bankCode": "044",
      "amount": 20000,
      "status": "successful",
      "responseCode": "00",
      "responseMessage": "Approved or completed successfully",
      "collectionType": "auto",
      "createdAt": "2026-10-15T02:00:15.000Z"
    },
    {
      "_id": "670fd1234a9b2c0018d99001",
      "mandateId": "66f1b8c4d29a430018a99101",
      "instalmentReference": "bec06990-36f0-4d93-8544-9dae351e8eaf",
      "accountNumber": "2178920069",
      "bankCode": "057",
      "amount": 20000,
      "status": "failed",
      "responseCode": "51",
      "responseMessage": "Insufficient funds",
      "collectionType": "auto",
      "createdAt": "2026-10-15T02:00:05.000Z"
    }
  ]
}

---

List Collections

Lists past collections across all your business mandates with optional filtering by collection mode, status, and search query.

GET /v1/recova/consent/business/collection?type=auto&status=successful
token: <YOUR_API_KEY>

Query Parameters

Parameter	Type	Required?	Description
type	string	Yes	Collection type: "auto" (scheduled) or "manual" (on-demand).
status	string	Optional	Filter by status (e.g. "successful", "failed", "pending").
search	string	Optional	Search query matching payer BVN or transaction reference.

---