Create Mandate

• Method: POST
• Endpoint: /api/v1/createMandate

Request Parameters

Request Parameters

Field Name	Type	Required	Description
accountNumber	String	Yes	The customer’s bank account number to be validated or debited.
accountName	String	Yes	Full name of the account holder as provided by the requesting institution. Used for identity matching and validation.
DateOfBirth	String	Yes	Customer’s date of birth in DDMMYYYY format (e.g., 24111994). Used for KYC verification against bank records.
MerchantId	String	Yes	Unique identifier assigned to the merchant or institution initiating the request.
requestId	String	Yes	Unique reference generated by the requesting system to identify and track the transaction or validation request. Must be globally unique per request.
BVN	String	Yes	Bank Verification Number of the customer. Used for regulatory compliance and identity verification.
tranAmt	Number	Yes	Transaction amount associated with the request. Can be used for limit checks, risk scoring, or authorization validation.

Response Parameters

Response Parameters

Response Parameters

Field Name	Type	Required	Description
MandateCode	String	Yes	Unique code identifying the mandate or direct debit instruction used to process the transaction.
ResponseCode	String	Yes	Standardized code indicating transaction status: • 00 = Success • Other codes indicate failure or errors.
responseMessage	String	Yes	Human-readable message describing the transaction outcome (e.g., SUCCESS, FAILED, PENDING).
requestId	String	Yes	Unique identifier of the original request. Helps in mapping the response back to the initiating request.
tranAmt	Number	Yes	Amount of the transaction processed under this mandate. Currency is assumed to match the original request.

Sample Request

Request Parameters

{
  "accountNumber": "2113003903",
  "accountName": "Casmirubozor",
  "DateOfBirth": "24111994",
  "MerchantId": "INSBPY4UBANG",
  "requestId": "TT4399200001",
  "BVN": "22100000017",
  "tranAmt": 100.0,
  "currency": "566"
}

Sample Response

Response Parameters

{
  "MandateCode": "90DLRO7",
  "ResponseCode": "00",
  "responseMessage": "SUCCESS",
  "requestId": "TT4399200001",
  "tranAmt": 100
}