API Functions

Here are the API functions available to you

Base URL

https://adjutor.lendsqr.com/

SMS Transactions Lookup

GET Transactions on SMS

GET https://adjutor.lendsqr.com/oraculi/sms/:mobile_number/transactions

This endpoint is used to get the transactions associated to a particular bank account from the user's bank SMS

Path Parameters

Name	Type	Description
mobile_number*	String	the phone number of the user

Headers

Name	Type	Description
Authorization*	String	Bearer <$APIKey>

200: OK Transactions found

Response body

{
"status":"success",
"message":"Successful",
"data":[
{
"sender":"AccessBank",
"type":"debit",
"amount":1460.75,
"narration":"099MJKL22352kM1U/TRF//FRM BELTHA idubamo slink TO Beltha Id",
"account_number":"168******653",
"balance":46.62,
"currency":"NGN",
"date":"2022-12-18 00:00:00"
},
{
"sender":"AccessBank",
"type":"debit",
"amount":30,
"narration":"099MJKL22353Fuff/901 Airtime Topup/[phone]/USSDETUSS",
"account_number":"168******653",
"balance":16.62,
"currency":"NGN",
"date":"2022-12-19 00:00:00"
},
{
"sender":"AccessBank",
"type":"credit",
"amount":30,
"narration":"099MJKL22353Fpze/REVERSAL FOR AIRTIME TOPUP FOR 07088500088",
"account_number":"168******653",
"balance":46.62,
"currency":"NGN",
"date":"2022-12-19 00:00:00"
}
],
"deprecation":{
"message":"We're deprecating this endpoint starting from 2023-04-01, please use the new version /v2/oraculi/sms/08128380177/transactions going forward."
},
"meta":{
"cost":20,
"balance":10490
}
}

Fields and descriptions

Response Data	Description
status	endpoint response status - success, fail.
message	endpoint response status message - successful, failed
sender	name of bank that sent the SMS type Type of transaction
type	type of transaction
amount	amount in contention
narration	narration of the transaction
account_number	account number of the user
balance	account balance of the user
currency	amount currency
date	date of transaction

SMS Accounts Lookup

GET Accounts on SMS

GET https://adjutor.lendsqr.com/oraculi/sms/entities/:bvn/accounts

This endpoint is used to get the accounts associated to a user from their bank SMS

Path Parameters

Name	Type	Description
bvn*	String	the bvn of the user

Headers

Name	Type	Description
Authorization*	String	Bearer <$APIKey>

200: OK Accounts found

Response body

{
    "status":"success",
    "message":"Successful",
    "data":{
    "accounts":[
    {
    "id":"5d9995bcfc2e35261676a2b1b3b24a93",
    "bank_code":"044",
    "account_number":"080******663",
    "balance":192.23,
    "last_balance_time":"2023-01-15T00:00:00.000Z"
    }
    ]
    },
    "deprecation":{
    "message":"We're deprecating this endpoint starting from 2023-04-01, please use the new version /v2/oraculi/sms/entities/22486928359/accounts going forward."
    },
    "meta":{
    "cost":10,
    "balance":84055
    }
    }

Fields and descriptions

Response Data	Description
status	endpoint response status - success, fail.
message	endpoint response status message - successful, failed
accounts.id	identifier attached to the account
accounts.bank_code	short code assigned to the bank
accounts.account_number	account number of the user
accounts.balance	account balance of the user
accounts.last_balance_time	last recorded time of the user’s bank balance