Get Loan Mandate By Reference

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

Description: This endpoint is to fetch loan mandate using loanReference

Sample Request

Request Parameters

Parameter	Type	Description	Required
loanReference	string	Unique loan reference for the mandate	Yes

GET /user/getMandate/{loanReference}

curl `${base_url}/user/getMandate/UU793753-90`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"

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
data	object	An object holding details of the loan mandate fetched	Yes
createdAt	string	Date record was created	Yes
updatedAt	string	Date record was updated	Yes
id	integer	Record identifier	Yes
bvn	string	BVN of the customer	Yes
loanReference	string	Loan reference	Yes
merchantId	string	Merchant Id	Yes
linkedAccountNumber	string	Customers account number the loan will be credited	Yes
bankCode	string	Customer’s Bank Code	Yes
loanAmount	decimal	Loan amount	Yes
customerID	string	Customer identifier	Yes
customerName	string	Customer name	Yes
customerEmail	string	Customer email	Yes
phoneNumber	string	Customer phone number	Yes
totalRepaymentExpected	decimal	Total amount expected	Yes
loanTenure	integer	Loan tenure	Yes
repaymentType	string	Repayment type	Yes
preferredRepaymentBankCBNCode	string	Bank code for repayment account	Yes
preferredRepaymentAccount	string	Customer’s preferred repayment account	Yes
status	integer	Loan mandate status where 0 = Inactive 1 = Active	Yes
collectionPaymentSchedule	array	An array holding repayment schedule objects as shown below:	Yes

collectionPaymentSchedule

Parameter	Type	Description	Mandatory
createdAt	string	Date record was created	Yes
updatedAt	string	Date record was updated	Yes
id	integer	Record identifier	Yes
repaymentDate	string	Date repayment is to be initiated	Yes
repaymentAmountInNaira	decimal	Amount to repay	Yes
transactionStatus	string	Transaction Status. This will be present after repayment has been initiated.	Yes
responseCode	string	Transaction response code. This will be present after repayment has been initiated.	Yes
responseMessage	string	Transaction response message. This will be present after repayment has been initiated.	Yes
loanReference	string	Loan reference schedule belongs	Yes
paymentReference	string	Payment reference for the schedule	Yes
transactionReference	string	Transaction reference. This will be present after the repayment has been initiated.	Yes

GET /user/getMandate/{loanReference}

{
  "status": "00",
  "message": "Successful",
  "data": {
    "createdAt": "2023-01-04T15:31:44.000+0000",
    "updatedAt": "2023-01-04T15:31:44.000+0000",
    "id": 1,
    "bvn": "1110739000",
    "loanReference": "UUWiYZlRi-971",
    "merchantId": "ANT-PEER",
    "linkedAccountNumber": "090705744",
    "bankCode": "057",
    "loanAmount": 2200.0,
    "customerID": "18",
    "customerName": "Charles",
    "customerEmail": "guru@test.com",
    "phoneNumber": "2347035583333",
    "totalRepaymentExpected": 200.0,
    "loanTenure": 2,
    "repaymentType": "Collection",
    "preferredRepaymentBankCBNCode": "224",
    "preferredRepaymentAccount": "090765844",
    "status": 1,
    "collectionPaymentSchedule": [
      {
        "createdAt": "2023-01-04T15:31:44.000+0000",
        "updatedAt": "2023-01-04T15:31:44.000+0000",
        "id": 1,
        "repaymentDate": "2022-11-11T23:57:15.286Z",
        "repaymentAmountInNaira": 150.0,
        "transactionStatus": null,
        "responseCode": null,
        "responseMessage": null,
        "loanReference": "UUWiYZlRi-971",
        "paymentReference": "UUWiYZlRi-971_01",
        "transactionReference": null
      },
      {
        "createdAt": "2023-01-04T15:31:45.000+0000",
        "updatedAt": "2023-01-04T15:31:45.000+0000",
        "id": 2,
        "repaymentDate": "2022-12-11T23:57:15.286Z",
        "repaymentAmountInNaira": 50.0,
        "transactionStatus": null,
        "responseCode": null,
        "responseMessage": null,
        "loanReference": "UUWiYZlRi-971",
        "paymentReference": "UUWiYZlRi-971_02",
        "transactionReference": null
      }
    ]
  }
}