Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
CRDB Direct Debit

Request Mandate Approval

Request CRDB Direct Debit mandate approval and create the linked payment schedule.

post/customers/crdb-direct-debit-mandate

Request body

phoneNumberstring required

Customer's SimBanking-registered phone number for the debit account. 12 digits, starts with country code, no plus sign.

debitAccountstring required

CRDB account number to debit

startDatestring required

Mandate start date (DD-MM-YYYY or YYYY-MM-DD)

endDatestring required

Mandate end date (DD-MM-YYYY or YYYY-MM-DD)

frequencyType'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' required

Installment frequency type

frequencynumber

Frequency multiplier (default: 1). Example: frequencyType=WEEKLY, frequency=2 means every 2 weeks

installmentAmountnumber required

Amount to debit per installment (must be positive)

mandateCallbackUrlstring uri required

URL where mandate status callbacks (ACTIVE, REJECTED, CANCELLED) will be sent

billDetailsstring

Optional description of the bill or mandate

Example request

{
  "customer": {
    "fullName": "Ramona Cormier-Hilll",
    "email": "Aurore56@yahoo.com",
    "phoneNumber": "255799468121"
  },
  "phoneNumber": "255754712650",
  "debitAccount": "0152590146100",
  "startDate": "10-12-2025",
  "endDate": "30-12-2025",
  "frequency": 2,
  "installmentAmount": 2500,
  "mandateCallbackUrl": "https://your-system.com/webhooks/crdb-mandate-status",
  "billDetails": "Loan No. 233422 from Inc."
}

Response

Mandate request accepted

mandateRequestIdstring

Unique identifier for the mandate request

mandateStatusstring

Current status of the mandate (typically REQUESTED)

paymentsTotalAmountnumber

Total amount scheduled over the mandate period

paymentsInstallmentsnumber

Total number of installments scheduled