This documents how a partner can integrate motherboard into their app using APIs
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20503503","collectionId":"d10423d0-b8a9-4610-9190-96860cd053ce","publishedId":"2sAYX6ogdE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-05T10:11:51.000Z"},"item":[{"name":"api","item":[{"name":"v1","item":[{"name":"auth","item":[{"name":"Login","item":[{"name":"token","item":[{"name":"Auth Controller partner Login","id":"e527e6ee-fc77-4a76-87b7-ea0ed2f21837","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secretId\": \"cGFydG5lcnVzZXJAYmxvbmRtYWlsLmNvbQ==\",\n \"secretKey\": \"KzIzNDgxMjI1NTQ0MzM6KzIzNDgxMjI1NTQ0MzM6MTczODY5ODMxOTk4OA==\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/auth/partner/token","urlObject":{"path":["api","v1","auth","partner","token"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"1fad7f68-5bbb-44c7-8ef9-0caa9daf1b78","name":"Sample Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secretId\": \"We use bearer token to access any motherboard APIs.
\n","_postman_id":"3a181613-74e2-4583-b55e-9004c0602267"},{"name":"refresh","item":[{"name":"Auth Controller refresh Token","id":"a9268dca-f2ec-40fb-b09b-71c98d3804b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"//api/v1/auth/refresh","urlObject":{"path":["api","v1","auth","refresh"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4dc68df9-bf96-46e8-aadc-0638843ed423","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"//api/v1/auth/refresh"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a9268dca-f2ec-40fb-b09b-71c98d3804b6"}],"id":"80acfbc4-ab23-4aed-a046-70574460a881","description":"Refresh auth token
\n","_postman_id":"80acfbc4-ab23-4aed-a046-70574460a881"},{"name":"Register","item":[{"name":"Register","id":"56911a8d-f3a5-4166-94bf-e0b38354e62b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"All requests to the motherboard API are authenticated using bearer token. To access the API you must sign up first using our company's details and a valid email address where a secret id and key you will use to authenticate all requests will be sent.
\n","_postman_id":"4bbb8e3b-9bde-46a6-b1ab-5bd0309fb5cb"},{"name":"state","item":[{"name":"List all motherboard states","id":"e0d4e2d0-363b-4a95-b703-56124e2444d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"//api/v1/state/public","urlObject":{"path":["api","v1","state","public"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"113d194c-64a1-4528-b2fd-4491a2dd8318","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"//api/v1/state/public"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e0d4e2d0-363b-4a95-b703-56124e2444d0"}],"id":"89552480-cff6-46db-b432-d40e630a7cc9","description":"Fetch motherboard states. Use this for endpoints that require state
\n","_postman_id":"89552480-cff6-46db-b432-d40e630a7cc9"},{"name":"user/employee management","item":[{"name":"{uuid}","item":[{"name":"Delete user","id":"256ee1a1-5965-4c5f-82c1-f8c3115819e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"//api/v1/apiPartners/user/:uuid","urlObject":{"path":["api","v1","apiPartners","user",":uuid"],"host":["/"],"query":[],"variable":[{"id":"1fa04996-134b-4942-a979-cf1dd6e3b8e4","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"Page number
\n","type":"text/plain"},"key":"page","value":"Page size
\n","type":"text/plain"},"key":"size","value":"User name
\n","type":"text/plain"},"key":"name","value":"User email
\n","type":"text/plain"},"key":"email","value":"Use this apis to manage user or employees that is people that redeem and enjoy the benefit
\nYou can register a user, update a user record or delete a user
\n","_postman_id":"d77b9a1c-4b82-48f5-8fbd-00c966433567"},{"name":"wallet","item":[{"name":"fund","item":[{"name":"Partner Transactions Controller initiate Fund Wallet","id":"a618da2e-56b5-4b6b-b863-1c6e63742383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5000\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/partner/wallet/fund","urlObject":{"path":["api","v1","partner","wallet","fund"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"c9664b02-afc1-451f-a75c-4a3be6ede22b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerPage number
\n","type":"text/plain"},"key":"page","value":"Page size
\n","type":"text/plain"},"key":"size","value":"The type of transaction. It could be debit or credit
\n","type":"text/plain"},"key":"transaction_type","value":"The provider for the transaction. it could be motherboard..
\n","type":"text/plain"},"key":"provider_type","value":"The minimum amount to fetch
\n","type":"text/plain"},"key":"min_amount","value":"The maximum amount to fetch
\n","type":"text/plain"},"key":"max_amount","value":"The status of the transactions to fetch
\n","type":"text/plain"},"key":"status","value":"You must fund wallet and your wallet balance must be able to cover the price for any benefit you plan to purchase.
\nUse the fund endpoint to initialize the transaction, a link will be returned to make payment on and confirm-payment API to confirm payment after it has been made on the paystack dashboard.
Use transctions endpoint to list previous transactions
(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Page number
\n","type":"text/plain"},"key":"page","value":"Page size
\n","type":"text/plain"},"key":"size","value":"The plan name
\n","type":"text/plain"},"key":"name","value":"The HMO uuid this plans belong to
\n","type":"text/plain"},"key":"hmo_uuid","value":"The state
\n","type":"text/plain"},"key":"state","value":"The plan types. It is comma separated
\n","type":"text/plain"},"key":"plan_types","value":"The ward types. it is comma separated
\n","type":"text/plain"},"key":"ward_types","value":"Filter by surgical coverage
\n","type":"text/plain"},"key":"surgery_coverage","value":"Filter by payment duration. It is a csv
\n","type":"text/plain"},"key":"payment_duration","value":"Filter by minimum price
\n","type":"text/plain"},"key":"price_min","value":"Filter by maximum price
\n","type":"text/plain"},"key":"price_max","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Page number
\n","type":"text/plain"},"key":"page","value":"Page size
\n","type":"text/plain"},"key":"size","value":"Name of hmo to return
\n","type":"text/plain"},"key":"name","value":"Name of state where hmo is
\n","type":"text/plain"},"key":"state","value":"Country name
\n","type":"text/plain"},"key":"country_name","value":"HMO status
\n","type":"text/plain"},"key":"status","value":"The HMOs with plans under this duration. It is CSV of plan duration. e.g 1,2,3
\n","type":"text/plain"},"key":"plan_duration","value":"The HMOS with the minimum plan price. It should be lesser than maximum price (plan_price_max)
\n","type":"text/plain"},"key":"plan_price_min","value":"The HMOS with the maximum plan price. . It should greater than the minimum price (plan_price_min)
\n","type":"text/plain"},"key":"plan_price_max","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"current page you want to fetch from, for pagination
\n","type":"text/plain"},"key":"page","value":"current size for pagination
\n","type":"text/plain"},"key":"size","value":"A string to filter merchants by their name
\n","type":"text/plain"},"key":"name","value":"minimum price for filter
\n","type":"text/plain"},"key":"min_price","value":"maximum price for filter
\n","type":"text/plain"},"key":"max_price","value":"Get all merchants belonging to a particular benefit category.
\n","type":"text/plain"},"key":"benefit_category_uuid","value":"Motherboard is a platform that helps employers provide flexible benefits for employees and empower the employees to use the benefits in the most affordable way.
The motherboard partner APIs enables our API partners provide the benefits on our platform to their users via API.
Benefits in the motherboard platforms are managed in a similar pattern except the health insurance which need a bit more details and specifications.
\nTo Purchase benefits on the motherboard platform go through the following steps:
\nRegister as a partner, a secret id and key will be sent to the email you use to register. Keep it and use it for your login to create a session
\nGenerate a bearer token by calling the login endpoint with the secret key and id sent.
\nCreate your users. Use the user/employee management endpoints to manage your users (people that will enjoy the benefit)
\na. Health benefit subscription
\n