Create Loan Mandate

base_url: https://demo.etranzact.com/bankit-api/antPeer/v1

Description : This endpoint is to create loan mandate

Sample Request

Request Parameters

Parameter	Type	Description	Required
loanMandate	object	An Object holding the loan mandate details	Yes
bvn	string	BVN of the customer the loan is given to.	Yes
merchantId	string	Merchant ID. This is to be verified before performing operation	Yes
loanReference	string	Unique loan reference	Yes
linkedAccountNumber	string	Customers account number the loan will be credited	No
loanAmount	integer	Loan amount provided to customer	Yes
customerID	string	Customer identifier	Yes
bankCode	string	Bank code linked account belongs to	Yes
customerName	string	Customer’s name	Yes
customerEmail	string	Customer’s email	Yes
phoneNumber	string	Customer’s phone number	Yes
totalRepaymentExpected	integer	Total amount expected to be repaid by the customer	Yes
loanTenure	integer	Duration of the loan. This should match the number of objects in collectionPaymentSchedule	Yes
repaymentType	string	Repayment type	Yes
preferredRepaymentBankCBNCode	string	Bank code for the preferred account repayment will be made from	Yes
preferredRepaymentAccount	string	Preferred account number repayment will be made from	Yes
collectionPaymentSchedule	array	An array holding the repayment schedule. Number of object present should match number specified in loan tenure	Yes
repaymentDate	string	Date repayment is to take place	Yes
repaymentAmountInNaira	integer	Amount to be repayed during the set date	Yes
paymentReference	string	Reference for the repayment schedule. This should be in the format loanReference_scheduleId	Yes

POST / user/addMandate

curl `{base_url}/user/addMandate`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X POST
-d '{
    "loanMandate":{
        "bvn": "1110739000",
        "merchantId": "ANT-PEER",
        "loanReference": "UUWiYZzRp-970",
        "linkedAccountNumber": "03405744",
        "loanAmount": 2200,
        "customerID": "8",
        "bankCode": "057",
        "customerName": "Charles",
        "customerEmail": "guru@test.com",
        "phoneNumber": "2347035583333",
        "totalRepaymentExpected": 200,
        "loanTenure": 2,
        "repaymentType": "Collection",
        "preferredRepaymentBankCBNCode": "224",
        "preferredRepaymentAccount": "094564844",
        "collectionPaymentSchedule": [
            {
            "repaymentDate": "2022-11-11T23:57:15.286Z",
            "repaymentAmountInNaira": 150,
            "paymentReference": "UUWiYZzRp-970_01"
            },
            {
            "repaymentDate": "2022-12-11T23:57:15.286Z",
            "repaymentAmountInNaira": 50,
            "paymentReference": "UUWiYZzRp-970_02"
            },
            {
            "repaymentDate": "2023-01-11T23:57:15.286Z",
            "repaymentAmountInNaira": 50,
            "paymentReference": "UUWiYZzRp-970_03"
            }
        ]
    }
}
'

Sample Response

Response Parameters

Parameter	Type	Description	Mandatory
status	string	Response Code of the operation. See Response Code in Response table	Yes
message	string	Response message for the operation. See response message in Response Table	Yes

POST / user/addMandate

{
  "status": "201",
  "message": "Created Successfully"
}