# Table of Contents - [Interstellas Documentation | API Docs](#interstellas-documentation-api-docs) - [Quick Start | API Docs](#quick-start-api-docs) - [Clients | API Docs](#clients-api-docs) - [API Reference | API Docs](#api-reference-api-docs) - [Audit | API Docs](#audit-api-docs) - [Payouts | API Docs](#payouts-api-docs) - [Authentication | API Docs](#authentication-api-docs) - [Members | API Docs](#members-api-docs) - [Virtual Account | API Docs](#virtual-account-api-docs) - [Business | API Docs](#business-api-docs) - [Settings | API Docs](#settings-api-docs) - [Subscription | API Docs](#subscription-api-docs) - [Customer / Account | API Docs](#customer-account-api-docs) - [Transactions | API Docs](#transactions-api-docs) - [Webhook | API Docs](#webhook-api-docs) - [Dispute | API Docs](#dispute-api-docs) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [API Reference | API Docs](#api-reference-api-docs) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) --- # Interstellas Documentation | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/interstellas-documentation.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs#welcome-to-interstellas) Welcome to Interstellas ----------------------------------------------------------------------------------------------------------------- Learn how to integrate our APIs into your application ### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs#introduction-api-basics) API Basics The Interstellas API gives you access to all the features you can use on our dashboard with much other available endpoints and lets you extend them for use in your application. The Api is RESTful and is organised around the main resources you would be interacting with API requests made without authentication will fail with the status code `401: Unauthorized`. > **Before you do anything** > > You should get your account credentials from the Interstellas team that you can test the API against. We will provide you with test keys that you can use to make API call. Always parse your API Secret Key to the header when making request to the endpoints [Quick Start](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start) ### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs#introduction-sample-requests) Sample Requests We provide sample API calls next to each method using http request method. All you need to do is insert your specific parameters, and you can test the calls. You can also use [Postman](https://www.getpostman.com/downloads/) if you run each API calls. Postman is an easy to use API development environment for making HTTP requests. You can download the [Interstellas Postman Collection](https://documenter.getpostman.com/view/3701162/UV5f7DdA) to make testing the API easier. ### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs#introduction-requests-response) Requests and Response Both request body data and response data are formatted as JSON. Content type for responses will always be `application/json`. Generally, all responses will be in the following format Copy { "status": [boolean], // Only true if the details provided could be processed and no error occured while processing "message": [string], // This gives more details about successful response or explains why status is false... Entirely informational. Please only log this but do not use for your checks "data": [object] // contains actionable result of processing if present } At times the pagination key is parsed to the response to provide context for the contents of the data. For instance, if a list of transactions performed by a customer is being retrieved, pagination parameters can be passed along to limit the result set. The pagination key will then contain an object with the following attributes: Copy "pagination": { "totalCount": 0, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 0 } Total Count This is the total number of transactions that were performed by the customer. Has Next Page Check if next page exist after current page Has Previous Page Check if previous page exist after current page Next Page This show what the next page number would be if "hasNextPage" is true Previous Page This show what the previous page number would be if "hasPreviousPage" is true Limit This is the maximum number of records that will be returned per request. This can be modified by passing a new value as a limit query parameter. **Default: 10** Last Page This shows the number of the last page [NextQuick Start](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start) Last updated 2 years ago --- # Quick Start | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start.md) . **Good to know:** A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation! [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start#get-your-api-keys) Get your API keys ----------------------------------------------------------------------------------------------------------------- Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error. You can generate an API key from your Dashboard at any time or get your keys through our API [here](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#get-keys) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start#make-your-first-request) Make your first request ----------------------------------------------------------------------------------------------------------------------------- To make your first request, send an authenticated request to the sign-in endpoint. This will create a `an access token to make request to other endpoints`. [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start#signin) Signin ------------------------------------------------------------------------------------------- `POST` `https://stella-thirdparty-api.herokuapp.com/api/v1/auth/signin` Creates a new pet. #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start#request-body) Request Body Name Type Description name\* string The name of the pet owner\_id string The `id` of the user who owns the pet species string The species of the pet breed string The breed of the pet 200 Pet successfully created 401 Permission denied Copy { "name"="Wilson", "owner": { "id": "sha7891bikojbkreuy", "name": "Samuel Passet", "species": "Dog",} "breed": "Golden Retriever", } **Good to know:** You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them. Take a look at how you might call this method using our official libraries, or via `curl`: curl Node Python Copy curl --location --request POST 'https://interstellas-api.stellasbank.com/api/v1/auth/signup' \ --data-raw '{ "businessName": "Bhord FC", "firstName": "Bodunde", "lastName": "Adetunji", "phoneNo": "08068486782", "email": "adetunjibodunde1@gmail.com", "password": "Password@101", "address": "No 23, Ilupeju Road Lagos", "countryId": "6ff6b422-42de-4eb7-a1a8-340850e2cd01", "isDeveloper": true }' Copy var axios = require('axios'); var data = JSON.stringify({ "businessName": "Bhord FC", "firstName": "Bodunde", "lastName": "Adetunji", "phoneNo": "08068486782", "email": "adetunjibodunde1@gmail.com", "password": "Password@101", "address": "No 23, Ilupeju Road Lagos", "countryId": "6ff6b422-42de-4eb7-a1a8-340850e2cd01", "isDeveloper": true }); var config = { method: 'post', url: 'https://stella-thirdparty-api.herokuapp.com/api/v1/auth/signup', headers: { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxMWMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY0NDU2MTA1NCwiZXhwIjoxNjQ0NzMzODU0fQ.Ge0bcb_G7pVuEpw_Xvo0rdl9iugNho1jBtvfHtDEgqc', 'Content-Type': 'application/json', }, data : data }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); }); Copy import requests import json url = "https://stella-thirdparty-api.herokuapp.com/api/v1/auth/signup" payload = json.dumps({ "businessName": "Bhord FC", "firstName": "Bodunde", "lastName": "Adetunji", "phoneNo": "08068486782", "email": "adetunjibodunde1@gmail.com", "password": "Password@101", "address": "No 23, Ilupeju Road Lagos", "countryId": "6ff6b422-42de-4eb7-a1a8-340850e2cd01", "isDeveloper": True }) headers = { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxMWMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY0NDU2MTA1NCwiZXhwIjoxNjQ0NzMzODU0fQ.Ge0bcb_G7pVuEpw_Xvo0rdl9iugNho1jBtvfHtDEgqc', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) [PreviousInterstellas Documentation](https://interstellas-api-doc-v1.stellasbank.com/api-docs) [NextAPI Reference](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference) Last updated 4 years ago --- # Clients | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients.md) . [Members](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members) [Business](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business) [Settings](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings) [PreviousAuthentication](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication) [NextMembers](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members) Last updated 4 years ago --- # API Reference | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference.md) . Dive into the specifics of each API endpoint by checking out our complete documentation. [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference#authentication) Authentication ----------------------------------------------------------------------------------------------------------------------- Everything related to Authentication: [Authentication](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference#clients) Clients --------------------------------------------------------------------------------------------------------- Everything related to clients: [Clients](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference#members) Members --------------------------------------------------------------------------------------------------------- All the crud operations related to Members: [Members](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference#business) Business ----------------------------------------------------------------------------------------------------------- Everything related to Business: [Business](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference#customer-account) Customer / Account ----------------------------------------------------------------------------------------------------------------------------- Everything related to customers and accounts: [Customer / Account](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account) [PreviousQuick Start](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start) [NextAuthentication](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication) Last updated 4 years ago --- # Audit | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit#get-audit-by-business) GET AUDIT BY BUSINESS ------------------------------------------------------------------------------------------------------------------------------------------------------------ `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/audits` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit#query-parameters) Query Parameters Name Type Description role String action String type String email String #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit#headers) Headers Name Type Description SECRET\_KEY String businessId String Authorization String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "460c258d-f279-41ae-ae38-a14f60f8e967",\ "email": "adetunjibodunde1@gmail.com",\ "user": "Bodunde Adetunji",\ "action": "create",\ "type": "SignIn",\ "date": "2022-01-26T11:44:33.649Z",\ "role": "User",\ "ipAddress": "::1"\ },\ {\ "id": "bcce839d-b136-4ae0-aade-c126050c076b",\ "email": "adetunjibodunde1@gmail.com",\ "user": "Bodunde Adetunji",\ "action": "create",\ "type": "SignIn",\ "date": "2022-01-26T11:39:08.589Z",\ "role": "User",\ "ipAddress": "::1"\ }\ ], "pagination": { "totalCount": 2, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit#get-audit-by-id) GET AUDIT BY ID ------------------------------------------------------------------------------------------------------------------------------------------------ `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/audits/{{auditId}}` 200: OK Copy { "status": true, "message": "Successful", "data": { "id": "460c258d-f279-41ae-ae38-a14f60f8e967", "email": "adetunjibodunde1@gmail.com", "user": "Bodunde Adetunji", "action": "create", "type": "SignIn", "date": "2022-01-26T11:44:33.649Z", "role": "User", "ipAddress": "::1" } } [PreviousTransactions](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions) [NextDispute](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute) Last updated 3 years ago --- # Payouts | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#add-payout-account) ADD PAYOUT ACCOUNT -------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#headers) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#request-body) Request Body Name Type Description accountName\* String accountNumber\* String bankName\* String bankCode\* String 200: OK Copy { "status": true, "message": "Payout account has been succeessfully added" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#get-payout-accounts) GET PAYOUT ACCOUNTS ---------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#headers-1) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "5ee3ca06-3825-49c2-9b8b-97cdf172ac4a",\ "accountName": "Adetunji Bodunde",\ "accountNumber": "0117170332",\ "bankCode": "058",\ "bankName": "GTB",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3",\ "createdAt": "2022-02-03T12:59:58.191Z"\ }\ ] } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#edit-payout-account) EDIT PAYOUT ACCOUNT ---------------------------------------------------------------------------------------------------------------------------------------------------------- `PUT` `https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/{{payoutAccountId}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#headers-2) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#request-body-1) Request Body Name Type Description accountName String accountNumber String bankName String bankCode String [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#delete-payout-account) DELETE PAYOUT ACCOUNT -------------------------------------------------------------------------------------------------------------------------------------------------------------- `DELETE` `https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/{{payoutAccountId}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts#headers-3) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Account has been deleted" } [PreviousSubscription](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription) [NextCustomer / Account](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account) Last updated 4 years ago --- # Authentication | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication.md) . The secret key however, are to be kept secret. If for any reason you believe your secret key has been compromised or you wish to reset them, you can do so from the dashboard. **Secure your secret key** Do not commit your secret keys to git, or use them in client-side code. Authorization headers should be in the following format: `Authorization: Bearer SECRET_KEY` **Sample Authorization Header** Authorization: Bearer `{{accessToken}}` SECRET\_KEY: "SECRET\_KEY: sk\_test\_6629mv8843ufuey74743611eec3111b8404" API requests made without authentication will fail with the status code `401: Unauthorized`. You can get the accessToken by calling the login endpoints with your login credentials. Copy the accessToken in the response and parse it to your authorization header [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#sign-in) SIGN IN ------------------------------------------------------------------------------------------------------------------------ The signin endpoints accept your email and password registered with your account `POST` `https://sandbox.stellasbank.com/api/v1/auth/signin` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#headers) Headers Name Type Description Content-Type\* String Only "application/json" is accepted for content-type #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#request-body) Request Body Name Type Description email\* String password\* String 201: Created Copy { "status": true, "message": "Client signin successful", "data": { "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "firstName": "Bodunde", "lastName": "Adetunji", "email": "adetunjibodunde1@gmail.com", "phoneNo": "08068486782", "countryName": "", "isDeveloper": false, "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkuWVCJ9.eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxUBMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY0MjQxOTk1MywiZXhwIjoxNjQyNTkyNzUzfQ.GLZLA29CNFi5SI7p0_jm3uuxF71zgJ_8NC54av82Ecw", "businesses": [\ {\ "id": "8ebe608c-bb1b-4e0e-b144-211c0f1hd82d",\ "businessName": "Bhord FC",\ "isApproved": false,\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ ] } } GET CURRENT LOGIN USER Get details of the current login user `GET` `https://sandbox.stellasbank.com/api/v1/auth/currentuser` 200: OK Copy { "currentUser": { "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "email": "adetunjibodunde1@gmail.com", "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3", "iat": 1642419953, "exp": 1642592753 } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#forgot-password) FORGOT PASSWORD ---------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/auth/forgotpassword` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#request-body-1) Request Body Name Type Description email\* String 201: Created Copy { "status": true, "message": "Email sent" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#reset-password) RESET PASSWORD -------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/auth/resetpassword` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#request-body-2) Request Body Name Type Description password\* String resetToken\* String The resetToken is the token sent to your email when you call forgotPassword endpoint 200: OK Copy { "status": true, "message": "Password reset is successful" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#change-password) CHANGE PASSWORD ---------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/auth/changepassword` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#headers-1) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer {{accessToken}} #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#request-body-3) Request Body Name Type Description oldPassword\* String newPassword\* String 201: Created Copy { "status": true, "message": "Password updated successfully" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#signout-user) SIGNOUT USER ---------------------------------------------------------------------------------------------------------------------------------- `POST` `https://stella-thirdparty-api.herokuapp.com/api/v1/api/auth/signout` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication#headers-2) Headers Name Type Description Authorization\* String Bearer {{accessToken}} 201: Created Copy { "status": true, "message": "Logout Successful" } [PreviousAPI Reference](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference) [NextClients](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients) Last updated 3 years ago --- # Members | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#add-member) ADD MEMBER ------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/members` This route requires that you parser secretKey and your businessId to the header of you request as well as the Authorization token #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#headers) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#request-body) Request Body Name Type Description email\* String memberRoleId\* String 201: Created Copy [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#get-members) GET MEMBERS --------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/members` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#headers-1) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "8deb756d-c460-4450-9b24-131739f8c824",\ "firstName": null,\ "lastName": null,\ "email": "adetunjibodunde14@gmail.com",\ "phoneNo": null,\ "isActive": true,\ "clientMemberRoleId": "75dc118e-304a-4f11-ae03-11dc00d222c8",\ "clientMemberRole": "Admin",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "ce41ebe2-00c4-475d-a05c-9d713ae56f3a",\ "firstName": "Emmanuel",\ "lastName": "Bhord",\ "email": "adetunji.bodunde@thegiggroupng.com",\ "phoneNo": "08022334455",\ "isActive": true,\ "clientMemberRoleId": "75dc118e-304a-4f11-ae03-11dc00d222c8",\ "clientMemberRole": "Admin",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ ], "pagination": { "totalCount": 3, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } GET MEMBERS ROLES `GET` `https://sandbox.stellasbank.com/api/v1/clients/members/roles` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#headers-2) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` \* String 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "75dc118e-304a-4f11-ae03-11dc00d222c8",\ "name": "Admin"\ },\ {\ "id": "aa601e18-0904-49d1-b00f-2ace5d1c6fd6",\ "name": "Developer"\ },\ {\ "id": "ad255d55-0452-4075-bc2f-efcc5ec8803e",\ "name": "User"\ }\ ] } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#complete-member-registration) COMPLETE MEMBER REGISTRATION ------------------------------------------------------------------------------------------------------------------------------------------------------------------- `PATCH` `https://sandbox.stellasbank.com/api/v1/clients/members/complete-registration` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#headers-3) Headers Name Type Description SECRET\_KEY\* String #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#request-body-1) Request Body Name Type Description authorizationToken\* String Token received from email when registered firstName\* String lastName\* String phoneNo\* String password\* String 200: OK Copy { "status": true, "message": "Membership Registration Completed" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members#update-member-details) UPDATE MEMBER DETAILS ----------------------------------------------------------------------------------------------------------------------------------------------------- `PATCH` `https://sandbox.stellasbank.com/api/v1/clients/members/a3d46e41-d347-4aaa-a80b-5b0033b2eb0c` 200: OK Copy { "status": true, "message": "Details updated successfully" } Open Request [PreviousClients](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients) [NextBusiness](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business) Last updated 3 years ago --- # Virtual Account | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#create-multi-use-virtual-account) Create Multi Use Virtual Account -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts/` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#headers) Headers Name Type Description SECRET\_KEY\* String {{SECRET\_KEY}} AUTHORIZATION\* String {{Bearer access\_token}} businessId\* String {{business\_id}} #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#request-body) Request Body Name Type Description firstName\* string John lastName\* string Doe type\* string temporal | permanent reference\* string Bu0oftiPtyMn duration string 36000 (in secs) 201: Created Copy { // Response } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#create-multi-use-virtual-account-sample-request) Create Multi Use Virtual Account Sample Request -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Curl Nodejs Python Copy curl --location --request POST '{{url}}/api/v1/clients/business/virtual-accountS' \ --header 'SECRET_KEY: {{secret_key}}' \ --header 'businessId: {{business_id}}\ --header Authorization': {{Bearer_Token}} \ --header 'Content-Type: application/json' \ --data-raw '{ "firstName": "Yomi", "lastName": "Ogunmola", "type": "temporal", "reference": "BuT8789fPtyMn", "duration": "2500" }' Copy const axios = require('axios'); const data = JSON.stringify({ "firstName": "Yomi", "lastName": "Ogunmola", "type": "temporal", "reference": "BuT8789fPtyMn", "duration": "2500" }); var config = { method: 'post', url: '{{url}}/api/v1/clients/business/virtual-accountS', headers = { 'SECRET_KEY': {{secret_key}}, 'businessId': {{business_id}}, 'Authorization': {{Bearer_Token}}, 'Content-Type': 'application/json' }, data : data }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); }); Copy // Some codeimport requests import json url = "{{url}}/api/v1/clients/business/virtual-accountS" payload = json.dumps({ "firstName": "Yomi", "lastName": "Ogunmola", "type": "temporal", "reference": "BuT8789fPtyMn", "duration": "2500" }) headers = { 'SECRET_KEY': {{secret_key}}, 'businessId': {{business_id}}, 'Authorization': {{Bearer_Token}}, 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#create-single-use-virtual-account) Create Single Use Virtual Account ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This is a single use virtual account. Account can only be use once. Note amount is in kobo [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#undefined-2) ------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts/single-use` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#headers-1) Headers Name Type Description SECRET\_KEY\* string {{SECRET\_KEY}} AUTHORIZATION\* string {{Bearer access\_token}} businessId\* string {{business\_id}} #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#request-body-1) Request Body Name Type Description firstName\* string John lastName\* string Doe refCode\* string Bu0oftiPtyMn duration\* string 36000 (in secs) amount\* string 500000 (in kobo) 201: Created Copy { "status": true, "message": "Account generated successfully", "data": { "accountNumber": "1100289334", "accountName": "Imole Aloba", "clientRef": "STL|HY69839HHDSF", "systemRef": "STL|HBU54js5sSuJi3", "amount": "400000", "expirationTime": "2023-09-30T12:46:10.846Z" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#create-single-use-virtual-account-sample-request) Create Single Use Virtual Account Sample Request ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Curl Nodejs Python Copy curl --location 'http://localhost:3005/api/v1/clients/business/virtual-accounts/single-use' \ --header 'SECRET_KEY: sk_test_66297ad97ae76d2b3611eec3111b8404' \ --header 'businessId: 8ebe608c-bb1b-4e0e-b144-211c0f1ad44d' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxMWMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY4ODU5MzQ5MywiZXhwIjoxNzMxNzkzNDkzfQ' \ --data '{ "firstName": "John", "lastName": "Doe", "refCode": "Bu0oftiPtyMn", "duration": "5", "amount": "500000" }' Copy const axios = require('axios'); let data = JSON.stringify({ "firstName": "Imole", "lastName": "Aloba", "refCode": "STL|HY69839HHDSF", "duration": "5", "amount": "400000" }); var config = { method: 'post', url: '{{url}}/api/v1/clients/business/virtual-accountS', headers = { 'SECRET_KEY': {{secret_key}}, 'businessId': {{business_id}}, 'Authorization': {{Bearer_Token}}, 'Content-Type': 'application/json' }, data : data }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); }); Copy import requests import json url = "http://localhost:3005/api/v1/clients/business/virtual-accounts/single-use" payload = json.dumps({ "firstName": "Imole", "lastName": "Aloba", "refCode": "STL|HY69839HHDSF", "duration": "5", "amount": "400000" }) headers = { 'SECRET_KEY': {{secret_key}}, 'businessId': {{business_id}}, 'Authorization': {{Bearer_Token}}, 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#get-virtual-account-details-by-business) GET VIRTUAL ACCOUNT DETAILS BY BUSINESS `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/virtual-account` Fetch all virtual accounts for your business #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#headers-2) Headers Name Type Description SECRET\_KEY\* string {{SECRET\_KEY}} AUTHORIZATION\* string {{Bearer access\_token}} businessId\* string {{business\_id}} 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "9926ca27-4c77-4a12-937b-3bd05fb46cc9",\ "clientRef": "UYuidf89Mn",\ "systemRef": "STL|Iq2ti4eUoGHT5L",\ "name": "Tola Ola",\ "accountNumber": "1100071448"\ },\ \ {\ "id": "c5ddfcdc-0755-4688-a9f6-eedf512e8a49",\ "clientRef": "BuT56oiPhhyts890",\ "systemRef": "STL|MAH1ZN5TfX8h2y",\ "name": "Lionel Messi",\ "accountNumber": "1100070159"\ },\ {\ "id": "cdb2f46f-7c46-4606-a5d4-8c08c6718b8c",\ "clientRef": "BuT56oiPtyMn",\ "systemRef": "STL|uoKqeHXdnkM9qr",\ "name": "Ben Tyson",\ "accountNumber": "1100070142"\ },\ {\ "id": "218551e1-b294-4ef8-b4e9-d64d85a25d86",\ "clientRef": "AZui89OpYZC",\ "systemRef": "STL|b5JET6irUOLSdv",\ "name": "Mbaka Aloy",\ "accountNumber": "1100070135"\ }\ ], "pagination": { "totalCount": 4, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } **VIRTUAL ACCOUNT TRANSFER** This is transfer between virtual accounts. Note amount is in kobo [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#use-this-endpoint-for-transfer-within-virtual-account) Use this endpoint for transfer within virtual account -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts/transfer` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#headers-3) Headers Name Type Description SECRET\_KEY\* string {{SECRET\_KEY}} AUTHORIZATION\* string {{Bearer access\_token}} businessId\* string {{business\_id}} #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#request-body-2) Request Body Name Type Description amount\* string 520000 receiverAccountNumber\* string 1100070135 payerAccountNumber\* string 1100063995 receiverBankCode\* string 100332 retrievalReference\* string 12jn9bkkgygdjjndh narration\* string DSTV FEE 200: OK Copy { "status": true, "message": "transfer successful", "data": { "amount": "520000", "transactionCharge": "0", "totalAmount": "520000" } } **GET SUSPENSE ACCOUNT TRANSACTIONS FOR SINGLE USE VA** Get all single use VA transactions that are moved to suspense account due to underpayment, overpayment or overtime payment `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/virtual-account` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account#headers-4) Headers Name Type Description SECRET\_KEY\* string {{SECRET\_KEY}} AUTHORIZATION\* string {{Bearer access\_token}} businessId\* string {{business\_id}} 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "recipientAccountNumber": "1100289279",\ "transactionId": "STL|R5THeihhV0JfXeLgqti9gVUf6BP5SmELGgP",\ "amountExpected": "600000",\ "amountReceived": "600000",\ "payerAccountNumber": "1100288863",\ "reason": "overtime",\ "transactiondate": "2023-09-23T21:02:22.455Z",\ "refundStatus": "pending"\ },\ {\ "recipientAccountNumber": "1100289224",\ "transactionId": "STL|dEiV9na31tsk4DiUmFwn5Vk9WOZ3TMToCWH",\ "amountExpected": "200000",\ "amountReceived": "300000",\ "payerAccountNumber": "1100288863",\ "reason": "overpayment",\ "transactiondate": "2023-09-21T13:04:23.822Z",\ "refundStatus": "pending"\ },\ {\ "recipientAccountNumber": "1100288973",\ "transactionId": "STL|cBmG1P3MTCqrxf9BHj8cCs0iEjjeC5Z9Kfw",\ "amountExpected": "300000",\ "amountReceived": "600000",\ "payerAccountNumber": "1100288863",\ "reason": "overpayment",\ "transactiondate": "2023-09-18T08:34:07.078Z",\ "refundStatus": "failed"\ },\ {\ "recipientAccountNumber": "1100288973",\ "transactionId": "STL|x6kgp9mRL9rzaeLoDfOwTTXYmKXIHgtFnOx",\ "amountExpected": "300000",\ "amountReceived": "100000",\ "payerAccountNumber": "1100288863",\ "reason": "underpayment",\ "transactiondate": "2023-09-18T06:58:25.292Z",\ "refundStatus": "success"\ }\ ], "pagination": { "totalCount": 23, "hasNextPage": true, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 3 } } [PreviousFund Account](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account/fund-account) [NextWebhook](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook) Last updated 2 years ago --- # Business | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#add-new-business) ADD NEW BUSINESS -------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#headers) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#request-body) Request Body Name Type Description countryId\* String businessName\* String isNewBusiness\* Boolean 200: OK Copy { "status": true, "message": "Business Created Successfully", "data": { "business": { "id": "c52c8c0e-b5fa-4b02-927f-c9b904848425", "businessName": "JoeBoy2 Ltd" } } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#get-businesses) GET BUSINESSES ---------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#headers-1) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "businessName": "Bhord FC",\ "bvn": "22257447645",\ "photoIdUrl": "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/photoId/1642695428_profile%20pics%202.jpeg",\ "businessDocumentsUrls": [\ "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/businessDocuments/1642695428_Official%20Business%20Document.docx"\ ],\ "isApproved": true,\ "residentialAddress": "No 50, Gbagada express Lagos",\ "stateId": 25,\ "state": "Lagos State",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "c52c8c0e-b5fa-4b02-927f-c9b904848425",\ "businessName": "JoeBoy2 Ltd",\ "bvn": null,\ "photoIdUrl": null,\ "businessDocumentsUrls": [],\ "isApproved": false,\ "residentialAddress": null,\ "stateId": null,\ "state": "",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ ], "pagination": { "totalCount": 2, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 20, "lastPage": 1 } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#validate-bvn-for-business) VALIDATE BVN FOR BUSINESS -------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/validate-bvn` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#headers-2) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#request-body-1) Request Body Name Type Description bvn\* String businessId\* String 200: OK Copy { "status": true, "message": "Bvn details retrieved", "data": { "phoneNumber": "08029348596", "bvn": "22257447645", "firstName": "JANE", "lastName": "DOE", "otherNames": "BOND", "dob": "20-Apr-90" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#complete-business-registration) COMPLETE BUSINESS REGISTRATION ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ `PATCH` `https://sandbox.stellasbank.com/api/v1/COMPLETE BUSINESS REGISTRATION` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#headers-3) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#request-body-2) Request Body Name Type Description photoId FormData businessDocuments FormData bvn FormData residentialAddress FormData password FormData otp FormData stateId FormData businessId FormData 200: OK Copy { "status": true, "message": "Details updated successfully" } GET BUSINESS ACCOUNT DETAILS `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/account-details` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#headers-4) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": { "accountNumber": "1100063995", "accountType": "SavingsOrCurrent", "customerId": "006399", "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "accountBalance": "0.00" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#get-customers-by-business) GET CUSTOMERS BY BUSINESS -------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/customers` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#headers-5) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "006438",\ "name": "JANE DOE",\ "phoneNo": "08029348596",\ "email": "kuti.lawrence@yopmail.com",\ "dateCreated": "2022-01-20T23:34:02.959Z",\ "nuban": null\ },\ {\ "id": "006402",\ "name": "Steven22 Farah22",\ "phoneNo": "08022402078",\ "email": "steve@stellas.com",\ "dateCreated": "2021-12-17T11:04:44.156Z",\ "nuban": "1100064026"\ },\ {\ "id": "006399",\ "name": "Bodunde Adetunji",\ "phoneNo": "08068486782",\ "email": "adetunjibodunde1@gmail.com",\ "dateCreated": "2021-12-08T14:53:42.361Z",\ "nuban": null\ }\ ], "pagination": { "totalCount": 3, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business#get-business-details) GET BUSINESS DETAILS ---------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/details` 200: OK Copy { "status": true, "message": "Successful", "data": { "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "businessName": "Bhord FC", "bvn": "22257447645", "photoIdUrl": "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/photoId/1643063972_profile%20pic3.jpeg", "businessDocumentsUrls": [\ "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/businessDocuments/1642695428_Official%20Business%20Document.docx",\ "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/businessDocuments/1643063972_Official%20Business%20Document.docx"\ ], "isApproved": true, "residentialAddress": "No 50, Gbagada express Lagos", "stateId": 25, "state": "Lagos State", "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3" } } [PreviousMembers](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members) [NextTransactions](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions) Last updated 3 years ago --- # Settings | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#get-keys) GET KEYS ---------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/settings/get-keys` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#headers) Headers Name Type Description Authorization String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": { "publicKey": "pk_test_fb892347d0c859dd0446a7c94e6f8a3", "secretKey": "sk_test_ff03c90f9520cf0e79c6d96c71964e2b" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#get-billers-settings) GET BILLERS SETTINGS ---------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/settings/billers` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#headers-1) Headers Name Type Description Authorization\* String Bearer `{{accessToken}}` SECRET\_KEY\* String 200: OK Copy { "status": true, "message": "Successful", "data": { "billers": [\ "908",\ "901",\ "913",\ "1017",\ "783"\ ] } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#configure-billers) CONFIGURE BILLERS ---------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/settings/configure-billers` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#headers-2) Headers Name Type Description Authorization\* String Bearer `{{accessToken}}` SECRET\_KEY\* String #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#request-body) Request Body Name Type Description billers String \["908", "901", "913"\] 200: OK Copy { "status": true, "message": "Billers has been updated" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#update-webhook-url) UPDATE WEBHOOK URL ------------------------------------------------------------------------------------------------------------------------------------------------ `POST` `https://sandbox.stellasbank.com/api/v1/clients/settings/update-webhook-url` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#headers-3) Headers Name Type Description Authorization\* String Bearer `{{accessToken}}` SECRET\_KEY\* String #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings#request-body-1) Request Body Name Type Description webhookUrl\* String [https://api.sample-webhook-url.com](https://api.bhord-webhook.com/) 200: OK Copy { "status": true, "message": "Webhook Url updated successfully" } [PreviousWebhook](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook) Last updated 3 years ago --- # Subscription | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription#add-subscription) ADD SUBSCRIPTION --------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/subscriptions` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription#headers) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription#request-body) Request Body Name Type Description amount\* String Specify amount in kobo packageName String Name of Package interval String Interval for package e.g daily, weekly, monthly, yearly 200: OK Copy { "status": true, "message": "Subscription is successfuly." } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription#get-subscriptions-by-business) GET SUBSCRIPTIONS BY BUSINESS ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/subscriptions` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription#query-parameters) Query Parameters Name Type Description packageName String interval String amount String keyword String search data by keyword #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription#headers-1) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "44006f34-ce53-46e8-80ec-1d0ab8d7c47e",\ "packageName": "Wakanda",\ "amount": "10000",\ "interval": "monthly",\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "51c35ca5-3cb6-46ee-a08e-77fda17940c4",\ "packageName": "Bellefull Package",\ "amount": "40000",\ "interval": "monthly",\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "3244bcb2-bfc8-436c-8a28-4a443327dac6",\ "packageName": "Gold",\ "amount": "10000",\ "interval": "monthly",\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ ], "pagination": { "totalCount": 3, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } [PreviousDispute](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute) [NextPayouts](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts) Last updated 4 years ago --- # Customer / Account | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#get-customer-account-balance) GET CUSTOMER ACCOUNT BALANCE ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/customers/balance/{{accountNumber}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#headers) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "account balance retrieved", "data": { "accountNumber": "1100063177", "availableBalance": "26024.50", "financialDate": "0001-01-01T00:00:00" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#create-customer-and-account) CREATE CUSTOMER AND ACCOUNT ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/customers/` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#headers-1) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` businessId\* String #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#request-body) Request Body Name Type Description firstName\* String lastName\* String otherNames String bvn\* String phoneNo\* String gender\* String placeOfBirth String dateOfBirth\* String address String nationalIdentityNo String email\* String 200: OK Copy { "status": true, "message": "Customer and accounted created successfully", "data": { "customerDetails": { "id": "006449", "firstName": "Steven22", "lastName": "Farah22", "email": "steve22@stellas.com", "bvn": "12345672522", "phoneNo": "08022402078", "gender": 0, "placeOfBirth": "Nigeria", "dateOfBirth": "1992-05-23", "address": "111 lekki, phase2,Lagos", "nationalIdentityNo": "192190929392", "accountTier": "1", "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3" }, "account_details": { "accountNumber": "1100064497", "accountType": "SavingsOrCurrent", "availableBalance": "0.00", "withdrawableBalance": "0", "customerId": "006449" } } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#get-customer-account-details) GET CUSTOMER ACCOUNT DETAILS ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/customers/{{customerId}}/account-details` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#headers-2) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "customer info retrieved successfully", "data": { "accountNumber": "1100064497", "accountType": "SavingsOrCurrent", "customerId": "006449", "businessId": "bb800589-3c6b-4020-ae44-68e586735ebc", "accountBalance": "0.00" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#update-account-tier) UPDATE ACCOUNT TIER ------------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/customers/update-account-tier` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#headers-3) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#request-body-1) Request Body Name Type Description accountNumber\* String Account Number to upgrade tier\* String Number of tier to upgrade to e.g "2" or "3" 200: OK Copy { "status": true, "message": "customer account updated successful" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#name-enquiry) NAME ENQUIRY ----------------------------------------------------------------------------------------------------------------------------------------------------- The endpoint is to get more data or validate account number `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/customers/name-enquiry` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#headers-4) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#request-body-2) Request Body Name Type Description accountNumber\* String bankCode\* String 200: OK Copy { "status": true, "message": "Account enquiry successful", "data": { "name": "JANE BOND DOE", "bvn": null, "kyc": null } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#get-banks) GET BANKS ----------------------------------------------------------------------------------------------------------------------------------------------- Here is the endpoints to get list of banks and back codes `GET` `https://sandbox.stellasbank.com/api/v1/banks` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account#headers-5) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "bank codes retrieved", "data": [\ {\ "name": "Stellas",\ "code": "100332"\ },\ {\ "name": "Skye Bank",\ "code": "076"\ },\ {\ "name": "Wema Bank",\ "code": "035"\ },\ {\ "name": "First Bank",\ "code": "011"\ },\ {\ "name": "Access Bank",\ "code": "044"\ },\ {\ "name": "CitiBank",\ "code": "023"\ },\ {\ "name": "Diamond",\ "code": "063"\ },\ {\ "name": "Eco Bank",\ "code": "050"\ },\ {\ "name": "Enterpise Bank (Spring)",\ "code": "084"\ },\ {\ "name": "FCMB",\ "code": "214"\ },\ {\ "name": "Fidelity",\ "code": "070"\ },\ {\ "name": "GTB",\ "code": "058"\ },\ {\ "name": "Keystone (Bank PHB)",\ "code": "082"\ },\ {\ "name": "Mainstreet(Afri Bank)",\ "code": "014"\ },\ {\ "name": "Stanbic IBTC",\ "code": "039"\ },\ {\ "name": "Sterling",\ "code": "232"\ },\ {\ "name": "UBA",\ "code": "033"\ },\ {\ "name": "Union Bank",\ "code": "032"\ },\ {\ "name": "Unity",\ "code": "215"\ },\ {\ "name": "Zenith",\ "code": "057"\ },\ {\ "name": "Mainstreet Bank",\ "code": "014"\ },\ {\ "name": "Heritage Bank",\ "code": "030"\ },\ {\ "name": "FinaTrust MFB",\ "code": "100022"\ }\ ] } [PreviousPayouts](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts) [NextTransfer / Withrawal](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account/transfer-withrawal) Last updated 3 years ago --- # Transactions | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#get-transaction-details) GET TRANSACTION DETAILS ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/transactions/76250c9ca-8364-4f60-a713-ecccbfcbeb82` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#headers) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "id": "47712f51-ed93-452c-b515-48b085b6abad", "transactionId": "STL|G1jkhf3OVh7vKco9z5iuKOz0gWxtkFTWiFi", "transactionType": "credit", "paymentMethod": null, "status": "pending", "amount": "350000", "transactionCharge": "15250", "totalCharge": "365250", "narration": "Upkeep allowance for my guy", "retrievalReference": "f3k03-7hbbbncrka4nkl9-8e41-c2gfdab5", "souceAccountInfo": null, "sourceAccountName": null, "destinationAccountInfo": "1100063995", "destinationAccountName": null, "customerName": null, "customerEmail": "", "paymentDate": "2021-12-09T23:03:39.601Z", "customerId": null } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#get-transactions-by-business) GET TRANSACTIONS BY BUSINESS --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/transactions` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#query-parameters) Query Parameters Name Type Description limit String page String customerId String status String amount String transactionType String transactionDetail String dateFrom String E.g 2021-09-01 dateTo String E.g 2022-01-15 keyword String This is use to search Transaction by keyword. Eg keyword=credit will search for all credit transaction #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#headers-1) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "abdf049b-c1ef-4bb5-9109-67b3a7fbc7af",\ "transactionId": "STL|Z1kUtCVELKl3zRdVE7XSWsqlXioMkjU94d0",\ "transactionType": "credit",\ "paymentMethod": null,\ "status": "pending",\ "amount": "400000",\ "transactionCharge": "16000",\ "totalCharge": "416000",\ "narration": "Upkeep allowance for my guy",\ "retrievalReference": "f3k03-7hbbb9gffa4-4nkldkl9-8e41-c2gfdab5",\ "souceAccountInfo": null,\ "sourceAccountName": null,\ "destinationAccountInfo": "1100063995",\ "destinationAccountName": null,\ "customerName": null,\ "customerEmail": "",\ "paymentDate": "2022-01-25T15:42:22.199Z",\ "customerId": null,\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "70f949bf-2b34-49ef-8899-5145b513f5a4",\ "transactionId": "STL|xayZ1k5UNKNLjbNpw6ZD0FwFRYk4qpyDm3a",\ "transactionType": "credit",\ "paymentMethod": null,\ "status": "pending",\ "amount": "400000",\ "transactionCharge": "16000",\ "totalCharge": "416000",\ "narration": "Upkeep allowance for my guy",\ "retrievalReference": "f3k03-7hbbbh889gffa4-4nkldkl9-8e41-c2gfdab5",\ "souceAccountInfo": null,\ "sourceAccountName": null,\ "destinationAccountInfo": "1100063995",\ "destinationAccountName": null,\ "customerName": null,\ "customerEmail": "",\ "paymentDate": "2022-01-25T06:30:49.251Z",\ "customerId": null,\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "47712f51-ed93-452c-b515-48b085b6abad",\ "transactionId": "STL|G1jkhf3OVh7vKco9z5iuKOz0gWxtkFTWiFi",\ "transactionType": "credit",\ "paymentMethod": null,\ "status": "pending",\ "amount": "350000",\ "transactionCharge": "15250",\ "totalCharge": "365250",\ "narration": "Upkeep allowance for my guy",\ "retrievalReference": "f3k03-7hbbbncrka4nkl9-8e41-c2gfdab5",\ "souceAccountInfo": null,\ "sourceAccountName": null,\ "destinationAccountInfo": "1100063995",\ "destinationAccountName": null,\ "customerName": null,\ "customerEmail": "",\ "paymentDate": "2021-12-09T23:03:39.601Z",\ "customerId": null,\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "6250c9ca-8364-4f60-a713-ecccbfcbeb82",\ "transactionId": "STL|y1A7YGQI9P179fzQH2YHiWQdHksrstvWLfW",\ "transactionType": "credit",\ "paymentMethod": null,\ "status": "pending",\ "amount": "300000",\ "transactionCharge": "14500",\ "totalCharge": "314500",\ "narration": "Upkeep allowance for my guy",\ "retrievalReference": "f3k03-7hbbbncrhjrka4nkl9-8e41-c2gfdab5",\ "souceAccountInfo": null,\ "sourceAccountName": null,\ "destinationAccountInfo": "1100063995",\ "destinationAccountName": null,\ "customerName": null,\ "customerEmail": "",\ "paymentDate": "2021-12-09T23:03:39.601Z",\ "customerId": null,\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ ], "pagination": { "totalCount": 4, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#get-transactions-by-clients) GET TRANSACTIONS BY CLIENTS ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/transactions/get-by-client` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#query-parameters-1) Query Parameters Name Type Description limit String page String customerId String status String amount String transactionType String transactionDetail String dateFrom String dateTo String keyword String This is use to search Transaction by keyword. Eg keyword=credit will search for all credit transaction #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#headers-2) Headers Name Type Description SECRET\_KEY\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "abdf049b-c1ef-4bb5-9109-67b3a7fbc7af",\ "transactionId": "STL|Z1kUtCVELKl3zRdVE7XSWsqlXioMkjU94d0",\ "transactionType": "credit",\ "paymentMethod": null,\ "status": "pending",\ "amount": "400000",\ "transactionCharge": "16000",\ "totalCharge": "416000",\ "narration": "Upkeep allowance for my guy",\ "retrievalReference": "f3k03-7hbbb9gffa4-4nkldkl9-8e41-c2gfdab5",\ "souceAccountInfo": null,\ "sourceAccountName": null,\ "destinationAccountInfo": "1100063995",\ "destinationAccountName": null,\ "customerName": null,\ "customerEmail": "",\ "paymentDate": "2022-01-25T15:42:22.199Z",\ "customerId": null,\ "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "9c8f0084-c325-4c87-9452-e07b3ca6fdf3",\ "transactionId": "STL|Y9xTQmQ9zN7EFYpi2SzbOeKfnw7FEvF1mnJ",\ "transactionType": "debit",\ "paymentMethod": null,\ "status": "pending",\ "amount": "1000",\ "transactionCharge": "0",\ "totalCharge": "1000",\ "narration": "DSTV MONI",\ "retrievalReference": "123429698ihfkkgy1nj7745hrfgju9439i58290",\ "souceAccountInfo": null,\ "sourceAccountName": "Bodunde Adetunji",\ "destinationAccountInfo": "1100062864",\ "destinationAccountName": "John Lawal",\ "customerName": null,\ "customerEmail": "adetunjibodunde1@gmail.com",\ "paymentDate": "2022-01-25T15:42:22.199Z",\ "customerId": "006399",\ "businessId": null,\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ ], "pagination": { "totalCount": 10, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } **REQUERY TRANSACTION** `POST` `https://sandbox.stellasbank.com/api/v1/clients/business/transactions/requery` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#headers-3) Headers Name Type Description SECRET\_KEY\* string Authorization\* string Bearer `{{accessToken}}` businessId\* string {{BUSINESSID}} #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions#request-body) Request Body Name Type Description retrievalReference\* String jgu2399nfk 200: OK Copy { // Response } [PreviousBusiness](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business) [NextAudit](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit) Last updated 3 years ago --- # Webhook | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook.md) . ### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook#create-a-webhook-url) Register a webhook URL A webhook URL is simply a `POST` endpoint that a resource server sends updates to. The URL needs to parse a JSON request and return a `200 OK`: `PATCH` `{{URL}}/clients/settings/update-webhook-url` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook#headers) Headers Name Type Description SECRET\_KEY\* String {{SECRET\_KEY}} AUTHORIZATION\* String {{Bearer access\_token}} #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook#request-body) Request Body Name Type Description webhookUrl String [https://api.bhord-webhook.com](https://api.bhord-webhook.com/) 200: OK Copy { "status": true, "message": "Webhook Url updated successfully" } `POST` `{{ Your webhook Url}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook#headers-1) Headers Name Type Description AUTH-KEY string To be provided by Stellas Key #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook#request-body-1) Request Body Name Type Description amount string Amount in kobo accountName string Payer Account Name accountNumber String Payer Account Number availableBalance string Customer account balance charge string Transaction charge depositorDetails String description String ledgerBalance String Ledger Balance narration String Narration recipientAccountNumber String Customer Account receiving fund recpientAccountName string Customer Account name transactionDate date transactionReference string Reference of transaction virtualAccountRef string [PreviousVirtual Account](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account) [NextSettings](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings) Last updated 3 years ago --- # Dispute | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute.md) . [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#add-dispute) ADD DISPUTE ------------------------------------------------------------------------------------------------------------------------------------------ `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/disputes` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#headers) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#request-body) Request Body Name Type Description transactionId\* String description\* String 200: OK Copy { "status": true, "message": "Dispute has been successfully added, our support team will attend to your concern" } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#get-disputes-by-business) GET DISPUTES BY BUSINESS -------------------------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/disputes` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#query-parameters) Query Parameters Name Type Description limit String page String transactionId String status String keyword String #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#headers-1) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": [\ {\ "id": "9d9043bc-ba0c-4055-bc06-da5989c0af0f",\ "transactionId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "description": "Not credited",\ "status": "pending",\ "dateCreated": "2022-01-26T18:24:13.669Z"\ },\ {\ "id": "e46f0693-8680-404d-a1ff-c833110f2f2e",\ "transactionId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "description": "Not credited",\ "status": "pending",\ "dateCreated": "2021-12-16T12:17:40.435Z"\ }\ ], "pagination": { "totalCount": 2, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#get-disputes-details) GET DISPUTES DETAILS ------------------------------------------------------------------------------------------------------------------------------------------------------------ `GET` `https://sandbox.stellasbank.com/api/v1/clients/business/disputes/{{id}}` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#headers-2) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Successful", "data": { "id": "9d9043bc-ba0c-4055-bc06-da5989c0af0f", "transactionId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "description": "Not credited", "status": "pending", "dateCreated": "2022-01-26T18:24:13.669Z" } } [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#update-dispute) UPDATE DISPUTE ------------------------------------------------------------------------------------------------------------------------------------------------ `GET` `https://sandbox.stellasbank.com/api/v1clients/business/disputes/9d9043bc-ba0c-4055-bc06-da5989c0af0f` #### [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute#headers-3) Headers Name Type Description SECRET\_KEY\* String businessId\* String Authorization\* String Bearer `{{accessToken}}` 200: OK Copy { "status": true, "message": "Dispute has been successfully updated" } [PreviousAudit](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit) [NextSubscription](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription) Last updated 3 years ago --- # Unknown \# API Docs ## API Docs - \[Interstellas Documentation\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/interstellas-documentation.md): Here is the Interstellas Api Documentation where you’ll learn how to integrate amazing experiences with the our API endpoints. - \[Quick Start\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start.md) - \[API Reference\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference.md) - \[Authentication\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication.md): Authenticate your API calls by including your secret key in the Authorization header of every request you make. You can manage your API keys from the dashboard. - \[Clients\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients.md) - \[Members\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members.md): All registered clients can add other members to access their account. You can also assigned roles to the member to defined what they can have access to on your account. - \[Business\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business.md) - \[Transactions\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions.md) - \[Audit\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit.md) - \[Dispute\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute.md) - \[Subscription\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription.md) - \[Payouts\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts.md): You can add maximum of 3 accounts to receive payments - \[Customer / Account\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account.md): These APIs help you create customer accounts and other customer and account related operations - \[Transfer / Withrawal\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account/transfer-withrawal.md) - \[Fund Account\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account/fund-account.md): These helps in funding account via credit card - \[Virtual Account\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account.md) - \[Webhook\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook.md): Get Notified via webhook when customers make payment. Note that you need to supply the your webhook url that we send notification on your Interstellas Dashboard (In settings) - \[Settings\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings.md) --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/interstellas-documentation.md). # Interstellas Documentation ## Welcome to Interstellas Learn how to integrate our APIs into your application ### API Basics The Interstellas API gives you access to all the features you can use on our dashboard with much other available endpoints and lets you extend them for use in your application. The Api is RESTful and is organised around the main resources you would be interacting with {% hint style="info" %} {% endhint %} API requests made without authentication will fail with the status code \`401: Unauthorized\`. > \*\*Before you do anything\*\* > > You should get your account credentials from the Interstellas team that you can test the API against. We will provide you with test keys that you can use to make API call. Always parse your API Secret Key to the header when making request to the endpoints {% content-ref url="/pages/lJoKsKFOn2H9S4NvsrVo" %} \[Quick Start\](/api-docs/quick-start.md) {% endcontent-ref %} ### Sample Requests We provide sample API calls next to each method using http request method. All you need to do is insert your specific parameters, and you can test the calls. \\ \\ You can also use \[Postman\](https://www.getpostman.com/downloads/) if you run each API calls. Postman is an easy to use API development environment for making HTTP requests. You can download the \[Interstellas Postman Collection\](https://documenter.getpostman.com/view/3701162/UV5f7DdA) to make testing the API easier. ### Requests and Response Both request body data and response data are formatted as JSON. Content type for responses will always be \`application/json\`. Generally, all responses will be in the following format {% code title="" %} \`\`\`javascript { "status": \[boolean\], // Only true if the details provided could be processed and no error occured while processing "message": \[string\], // This gives more details about successful response or explains why status is false... Entirely informational. Please only log this but do not use for your checks "data": \[object\] // contains actionable result of processing if present } \`\`\` {% endcode %} At times the pagination key is parsed to the response to provide context for the contents of the data. For instance, if a list of transactions performed by a customer is being retrieved, pagination parameters can be passed along to limit the result set. The pagination key will then contain an object with the following attributes: \`\`\` "pagination": { "totalCount": 0, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 0 } \`\`\`
Total CountThis is the total number of transactions that were performed by the customer.
Has Next PageCheck if next page exist after current page
Has Previous PageCheck if previous page exist after current page
Next PageThis show what the next page number would be if "hasNextPage" is true
Previous PageThis show what the previous page number would be if "hasPreviousPage" is true
LimitThis is the maximum number of records that will be returned per request. This can be modified by passing a new value as a limit query parameter. Default: 10
Last PageThis shows the number of the last page
--- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start.md). # Quick Start {% hint style="info" %} \*\*Good to know:\*\* A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation! {% endhint %} ## Get your API keys Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error. You can generate an API key from your Dashboard at any time or get your keys through our API \[here\](/api-docs/reference/api-reference/clients/settings.md#get-keys). ## Make your first request To make your first request, send an authenticated request to the sign-in endpoint. This will create a \`an access token to make request to other endpoints\`. ## Signin \`POST\` \`https://stella-thirdparty-api.herokuapp.com/api/v1/auth/signin\` Creates a new pet. #### Request Body | Name | Type | Description | | -------------------------------------- | ------ | ------------------------------------- | | name\\\* | string | The name of the pet | | owner\\\_id | string | The \`id\` of the user who owns the pet | | species | string | The species of the pet | | breed | string | The breed of the pet | {% tabs %} {% tab title="200 Pet successfully created" %} \`\`\`javascript { "name"="Wilson", "owner": { "id": "sha7891bikojbkreuy", "name": "Samuel Passet", "species": "Dog",} "breed": "Golden Retriever", } \`\`\` {% endtab %} {% tab title="401 Permission denied" %} {% endtab %} {% endtabs %} {% hint style="info" %} \*\*Good to know:\*\* You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them. {% endhint %} Take a look at how you might call this method using our official libraries, or via \`curl\`: {% tabs %} {% tab title="curl" %} \`\`\` curl --location --request POST 'https://interstellas-api.stellasbank.com/api/v1/auth/signup' \\ --data-raw '{ "businessName": "Bhord FC", "firstName": "Bodunde", "lastName": "Adetunji", "phoneNo": "08068486782", "email": "adetunjibodunde1@gmail.com", "password": "Password@101", "address": "No 23, Ilupeju Road Lagos", "countryId": "6ff6b422-42de-4eb7-a1a8-340850e2cd01", "isDeveloper": true }' \`\`\` {% endtab %} {% tab title="Node" %} \`\`\`javascript var axios = require('axios'); var data = JSON.stringify({ "businessName": "Bhord FC", "firstName": "Bodunde", "lastName": "Adetunji", "phoneNo": "08068486782", "email": "adetunjibodunde1@gmail.com", "password": "Password@101", "address": "No 23, Ilupeju Road Lagos", "countryId": "6ff6b422-42de-4eb7-a1a8-340850e2cd01", "isDeveloper": true }); var config = { method: 'post', url: 'https://stella-thirdparty-api.herokuapp.com/api/v1/auth/signup', headers: { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxMWMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY0NDU2MTA1NCwiZXhwIjoxNjQ0NzMzODU0fQ.Ge0bcb\_G7pVuEpw\_Xvo0rdl9iugNho1jBtvfHtDEgqc', 'Content-Type': 'application/json', }, data : data }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); }); \`\`\` {% endtab %} {% tab title="Python" %} \`\`\`python import requests import json url = "https://stella-thirdparty-api.herokuapp.com/api/v1/auth/signup" payload = json.dumps({ "businessName": "Bhord FC", "firstName": "Bodunde", "lastName": "Adetunji", "phoneNo": "08068486782", "email": "adetunjibodunde1@gmail.com", "password": "Password@101", "address": "No 23, Ilupeju Road Lagos", "countryId": "6ff6b422-42de-4eb7-a1a8-340850e2cd01", "isDeveloper": True }) headers = { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxMWMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY0NDU2MTA1NCwiZXhwIjoxNjQ0NzMzODU0fQ.Ge0bcb\_G7pVuEpw\_Xvo0rdl9iugNho1jBtvfHtDEgqc', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) \`\`\` {% endtab %} {% endtabs %} --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients.md). # Clients - \[Members\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members.md): All registered clients can add other members to access their account. You can also assigned roles to the member to defined what they can have access to on your account. - \[Business\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business.md) - \[Transactions\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/transactions.md) - \[Audit\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/audit.md) - \[Dispute\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/dispute.md) - \[Subscription\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/subscription.md) - \[Payouts\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/payouts.md): You can add maximum of 3 accounts to receive payments - \[Customer / Account\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account.md): These APIs help you create customer accounts and other customer and account related operations - \[Transfer / Withrawal\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account/transfer-withrawal.md) - \[Fund Account\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account/fund-account.md): These helps in funding account via credit card - \[Virtual Account\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/virtual-account.md) - \[Webhook\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/webhook.md): Get Notified via webhook when customers make payment. Note that you need to supply the your webhook url that we send notification on your Interstellas Dashboard (In settings) - \[Settings\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings.md) --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference.md). # API Reference Dive into the specifics of each API endpoint by checking out our complete documentation. ## Authentication Everything related to Authentication: {% content-ref url="/pages/VEFR5Bkrs3KVz7XWE1fv" %} \[Authentication\](/api-docs/reference/api-reference/authentication.md) {% endcontent-ref %} ## Clients Everything related to clients: {% content-ref url="/pages/YV9qiekizBUuRzWKJS7N" %} \[Clients\](/api-docs/reference/api-reference/clients.md) {% endcontent-ref %} ## Members All the crud operations related to Members: {% content-ref url="/pages/RxH2fU1T1PNPaWgpsf7T" %} \[Members\](/api-docs/reference/api-reference/clients/members.md) {% endcontent-ref %} ## Business Everything related to Business: {% content-ref url="/pages/iC2z6aTnJHjDvUkewtA9" %} \[Business\](/api-docs/reference/api-reference/clients/business.md) {% endcontent-ref %} ## Customer / Account Everything related to customers and accounts: {% content-ref url="/pages/Xwle6DdcJ7jr7iNSsR2V" %} \[Customer / Account\](/api-docs/reference/api-reference/clients/business/customer-account.md) {% endcontent-ref %} --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication.md). # Authentication The secret key however, are to be kept secret. If for any reason you believe your secret key has been compromised or you wish to reset them, you can do so from the dashboard. {% hint style="warning" %} \*\*Secure your secret key\*\* Do not commit your secret keys to git, or use them in client-side code. {% endhint %} Authorization headers should be in the following format: \`Authorization: Bearer SECRET\_KEY\` {% hint style="info" %} \*\*Sample Authorization Header\*\* Authorization: Bearer \`{{accessToken}}\` SECRET\\\_KEY: "SECRET\\\_KEY: sk\\\_test\\\_6629mv8843ufuey74743611eec3111b8404" {% endhint %} API requests made without authentication will fail with the status code \`401: Unauthorized\`. You can get the accessToken by calling the login endpoints with your login credentials. Copy the accessToken in the response and parse it to your authorization header ## SIGN IN The signin endpoints accept your email and password registered with your account \`POST\` \`https://sandbox.stellasbank.com/api/v1/auth/signin\` #### Headers | Name | Type | Description | | ---------------------------------------------- | ------ | ---------------------------------------------------- | | Content-Type\\\* | String | Only "application/json" is accepted for content-type | #### Request Body | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | email\\\* | String | | | password\\\* | String | | {% tabs %} {% tab title="201: Created " %} \`\`\`javascript { "status": true, "message": "Client signin successful", "data": { "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "firstName": "Bodunde", "lastName": "Adetunji", "email": "adetunjibodunde1@gmail.com", "phoneNo": "08068486782", "countryName": "", "isDeveloper": false, "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkuWVCJ9.eyJpZCI6IjhlYmU2MDhjLWJiMWItNGUwZS1iMTQ0LTIxUBMwZjFhZDQ0ZCIsImVtYWlsIjoiYWRldHVuamlib2R1bmRlMUBnbWFpbC5jb20iLCJjbGllbnRJZCI6IjM2N2Y1ZTJhLWJiYzctNDg2NS05YmQzLWVkNjUzMDk0YjZmMyIsImlhdCI6MTY0MjQxOTk1MywiZXhwIjoxNjQyNTkyNzUzfQ.GLZLA29CNFi5SI7p0\_jm3uuxF71zgJ\_8NC54av82Ecw", "businesses": \[\ {\ "id": "8ebe608c-bb1b-4e0e-b144-211c0f1hd82d",\ "businessName": "Bhord FC",\ "isApproved": false,\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ \] } } \`\`\` {% endtab %} {% endtabs %} GET CURRENT LOGIN USER Get details of the current login user \`GET\` \`https://sandbox.stellasbank.com/api/v1/auth/currentuser\` {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "currentUser": { "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "email": "adetunjibodunde1@gmail.com", "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3", "iat": 1642419953, "exp": 1642592753 } } \`\`\` {% endtab %} {% endtabs %} ## FORGOT PASSWORD \`POST\` \`https://sandbox.stellasbank.com/api/v1/auth/forgotpassword\` #### Request Body | Name | Type | Description | | --------------------------------------- | ------ | ----------- | | email\\\* | String | | {% tabs %} {% tab title="201: Created " %} \`\`\`javascript { "status": true, "message": "Email sent" } \`\`\` {% endtab %} {% endtabs %} ## RESET PASSWORD \`POST\` \`https://sandbox.stellasbank.com/api/v1/auth/resetpassword\` #### Request Body | Name | Type | Description | | -------------------------------------------- | ------ | ------------------------------------------------------------------------------------ | | password\\\* | String | | | resetToken\\\* | String | The resetToken is the token sent to your email when you call forgotPassword endpoint | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Password reset is successful" } \`\`\` {% endtab %} {% endtabs %} ## CHANGE PASSWORD \`POST\` \`https://sandbox.stellasbank.com/api/v1/auth/changepassword\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ---------------------- | | SECRET\\\_KEY\\\* | String | | | Authorization\\\* | String | Bearer {{accessToken}} | #### Request Body | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | oldPassword\\\* | String | | | newPassword\\\* | String | | {% tabs %} {% tab title="201: Created " %} \`\`\`javascript { "status": true, "message": "Password updated successfully" } \`\`\` {% endtab %} {% endtabs %} ## SIGNOUT USER \`POST\` \`https://stella-thirdparty-api.herokuapp.com/api/v1/api/auth/signout\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ---------------------- | | Authorization\\\* | String | Bearer {{accessToken}} | {% tabs %} {% tab title="201: Created " %} \`\`\`javascript { "status": true, "message": "Logout Successful" } \`\`\` {% endtab %} {% endtabs %} --- # API Reference | API Docs For the complete documentation index, see [llms.txt](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt) . This page is also available as [Markdown](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference.md) . Dive into the specifics of each API endpoint by checking out our complete documentation. [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference#authentication) Authentication --------------------------------------------------------------------------------------------------------- Everything related to Authentication: [Authentication](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference#clients) Clients ------------------------------------------------------------------------------------------- Everything related to clients: [Clients](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference#members) Members ------------------------------------------------------------------------------------------- All the crud operations related to Members: [Members](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference#business) Business --------------------------------------------------------------------------------------------- Everything related to Business: [Business](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business) [](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference#customer-account) Customer / Account --------------------------------------------------------------------------------------------------------------- Everything related to customers and accounts: [Customer / Account](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business/customer-account) [PreviousQuick Start](https://interstellas-api-doc-v1.stellasbank.com/api-docs/quick-start) [NextAuthentication](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/authentication) Last updated 4 years ago --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/members.md). # Members ## ADD MEMBER \`POST\` \`https://sandbox.stellasbank.com/api/v1/clients/members\` This route requires that you parser secretKey and your businessId to the header of you request as well as the Authorization token #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | businessId\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | #### Request Body | Name | Type | Description | | ---------------------------------------------- | ------ | ----------- | | email\\\* | String | | | memberRoleId\\\* | String | | {% tabs %} {% tab title="201: Created " %} \`\`\`javascript \`\`\` {% endtab %} {% endtabs %} ## GET MEMBERS \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/members\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | businessId\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": \[\ {\ "id": "8deb756d-c460-4450-9b24-131739f8c824",\ "firstName": null,\ "lastName": null,\ "email": "adetunjibodunde14@gmail.com",\ "phoneNo": null,\ "isActive": true,\ "clientMemberRoleId": "75dc118e-304a-4f11-ae03-11dc00d222c8",\ "clientMemberRole": "Admin",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "ce41ebe2-00c4-475d-a05c-9d713ae56f3a",\ "firstName": "Emmanuel",\ "lastName": "Bhord",\ "email": "adetunji.bodunde@thegiggroupng.com",\ "phoneNo": "08022334455",\ "isActive": true,\ "clientMemberRoleId": "75dc118e-304a-4f11-ae03-11dc00d222c8",\ "clientMemberRole": "Admin",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ \], "pagination": { "totalCount": 3, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } \`\`\` {% endtab %} {% endtabs %} GET MEMBERS ROLES \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/members/roles\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | | \\\* | String | | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": \[\ {\ "id": "75dc118e-304a-4f11-ae03-11dc00d222c8",\ "name": "Admin"\ },\ {\ "id": "aa601e18-0904-49d1-b00f-2ace5d1c6fd6",\ "name": "Developer"\ },\ {\ "id": "ad255d55-0452-4075-bc2f-efcc5ec8803e",\ "name": "User"\ }\ \] } \`\`\` {% endtab %} {% endtabs %} ## COMPLETE MEMBER REGISTRATION \`PATCH\` \`https://sandbox.stellasbank.com/api/v1/clients/members/complete-registration\` #### Headers | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | SECRET\\\_KEY\\\* | String | | #### Request Body | Name | Type | Description | | ---------------------------------------------------- | ------ | ----------------------------------------- | | authorizationToken\\\* | String | Token received from email when registered | | firstName\\\* | String | | | lastName\\\* | String | | | phoneNo\\\* | String | | | password\\\* | String | | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Membership Registration Completed" } \`\`\` {% endtab %} {% endtabs %} ## UPDATE MEMBER DETAILS \`PATCH\` \`https://sandbox.stellasbank.com/api/v1/clients/members/a3d46e41-d347-4aaa-a80b-5b0033b2eb0c\` {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Details updated successfully" } \`\`\` {% endtab %} {% endtabs %} Open Request
--- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/settings.md). # Settings ## GET KEYS
\`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/settings/get-keys\` #### Headers | Name | Type | Description | | ------------- | ------ | ------------------------ | | Authorization | String | Bearer \`{{accessToken}}\` | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": { "publicKey": "pk\_test\_fb892347d0c859dd0446a7c94e6f8a3", "secretKey": "sk\_test\_ff03c90f9520cf0e79c6d96c71964e2b" } } \`\`\` {% endtab %} {% endtabs %} ## GET BILLERS SETTINGS \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/settings/billers\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | | SECRET\\\_KEY\\\* | String | | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": { "billers": \[\ "908",\ "901",\ "913",\ "1017",\ "783"\ \] } } \`\`\` {% endtab %} {% endtabs %} ## CONFIGURE BILLERS \`POST\` \`https://sandbox.stellasbank.com/api/v1/clients/settings/configure-billers\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | | SECRET\\\_KEY\\\* | String | | #### Request Body | Name | Type | Description | | ------- | ------ | ---------------------- | | billers | String | \\\["908", "901", "913"\] | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Billers has been updated" } \`\`\` {% endtab %} {% endtabs %} ## UPDATE WEBHOOK URL \`POST\` \`https://sandbox.stellasbank.com/api/v1/clients/settings/update-webhook-url\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | | SECRET\\\_KEY\\\* | String | | #### Request Body | Name | Type | Description | | -------------------------------------------- | ------ | ------------------------------------------------------------------- | | webhookUrl\\\* | String | \[https://api.sample-webhook-url.com\](https://api.bhord-webhook.com) | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Webhook Url updated successfully" } \`\`\` {% endtab %} {% endtabs %} --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://interstellas-api-doc-v1.stellasbank.com/api-docs/reference/api-reference/clients/business.md). # Business ## ADD NEW BUSINESS \`POST\` \`https://sandbox.stellasbank.com/api/v1/clients/business\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | #### Request Body | Name | Type | Description | | ----------------------------------------------- | ------- | ----------- | | countryId\\\* | String | | | businessName\\\* | String | | | isNewBusiness\\\* | Boolean | | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Business Created Successfully", "data": { "business": { "id": "c52c8c0e-b5fa-4b02-927f-c9b904848425", "businessName": "JoeBoy2 Ltd" } } } \`\`\` {% endtab %} {% endtabs %} ## GET BUSINESSES \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/business\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": \[\ {\ "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d",\ "businessName": "Bhord FC",\ "bvn": "22257447645",\ "photoIdUrl": "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/photoId/1642695428\_profile%20pics%202.jpeg",\ "businessDocumentsUrls": \[\ "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/businessDocuments/1642695428\_Official%20Business%20Document.docx"\ \],\ "isApproved": true,\ "residentialAddress": "No 50, Gbagada express Lagos",\ "stateId": 25,\ "state": "Lagos State",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ },\ {\ "id": "c52c8c0e-b5fa-4b02-927f-c9b904848425",\ "businessName": "JoeBoy2 Ltd",\ "bvn": null,\ "photoIdUrl": null,\ "businessDocumentsUrls": \[\],\ "isApproved": false,\ "residentialAddress": null,\ "stateId": null,\ "state": "",\ "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3"\ }\ \], "pagination": { "totalCount": 2, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 20, "lastPage": 1 } } \`\`\` {% endtab %} {% endtabs %} ## VALIDATE BVN FOR BUSINESS \`POST\` \`https://sandbox.stellasbank.com/api/v1/clients/business/validate-bvn\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | #### Request Body | Name | Type | Description | | -------------------------------------------- | ------ | ----------- | | bvn\\\* | String | | | businessId\\\* | String | | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Bvn details retrieved", "data": { "phoneNumber": "08029348596", "bvn": "22257447645", "firstName": "JANE", "lastName": "DOE", "otherNames": "BOND", "dob": "20-Apr-90" } } \`\`\` {% endtab %} {% endtabs %} ## COMPLETE BUSINESS REGISTRATION \`PATCH\` \`https://sandbox.stellasbank.com/api/v1/COMPLETE BUSINESS REGISTRATION\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | #### Request Body | Name | Type | Description | | ------------------ | -------- | ----------- | | photoId | FormData | | | businessDocuments | FormData | | | bvn | FormData | | | residentialAddress | FormData | | | password | FormData | | | otp | FormData | | | stateId | FormData | | | businessId | FormData | | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Details updated successfully" } \`\`\` {% endtab %} {% endtabs %} GET BUSINESS ACCOUNT DETAILS \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/business/account-details\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | businessId\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": { "accountNumber": "1100063995", "accountType": "SavingsOrCurrent", "customerId": "006399", "businessId": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "accountBalance": "0.00" } } \`\`\` {% endtab %} {% endtabs %} ## GET CUSTOMERS BY BUSINESS \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/business/customers\` #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------ | | SECRET\\\_KEY\\\* | String | | | businessId\\\* | String | | | Authorization\\\* | String | Bearer \`{{accessToken}}\` | {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": \[\ {\ "id": "006438",\ "name": "JANE DOE",\ "phoneNo": "08029348596",\ "email": "kuti.lawrence@yopmail.com",\ "dateCreated": "2022-01-20T23:34:02.959Z",\ "nuban": null\ },\ {\ "id": "006402",\ "name": "Steven22 Farah22",\ "phoneNo": "08022402078",\ "email": "steve@stellas.com",\ "dateCreated": "2021-12-17T11:04:44.156Z",\ "nuban": "1100064026"\ },\ {\ "id": "006399",\ "name": "Bodunde Adetunji",\ "phoneNo": "08068486782",\ "email": "adetunjibodunde1@gmail.com",\ "dateCreated": "2021-12-08T14:53:42.361Z",\ "nuban": null\ }\ \], "pagination": { "totalCount": 3, "hasNextPage": false, "hasPreviousPage": false, "nextPage": 2, "previousPage": 0, "limit": 10, "lastPage": 1 } } \`\`\` {% endtab %} {% endtabs %} ## GET BUSINESS DETAILS \`GET\` \`https://sandbox.stellasbank.com/api/v1/clients/business/details\` {% tabs %} {% tab title="200: OK " %} \`\`\`javascript { "status": true, "message": "Successful", "data": { "id": "8ebe608c-bb1b-4e0e-b144-211c0f1ad44d", "businessName": "Bhord FC", "bvn": "22257447645", "photoIdUrl": "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/photoId/1643063972\_profile%20pic3.jpeg", "businessDocumentsUrls": \[\ "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/businessDocuments/1642695428\_Official%20Business%20Document.docx",\ "https://stellas-third-party.s3.amazonaws.com/BUSINESS/Bhord%20FC/businessDocuments/1643063972\_Official%20Business%20Document.docx"\ \], "isApproved": true, "residentialAddress": "No 50, Gbagada express Lagos", "stateId": 25, "state": "Lagos State", "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3" } } \`\`\` {% endtab %} {% endtabs %} ---