Cushy Access is a Logistics and Q-Commerce platform (cushyaccess.com) that enables businesses and developers to integrate delivery and order management services into their applications.
This documentation provides details for connecting to our APIs using Postman or your preferred API client.
Base URL: please contact us for info on this
\nPostman Collection: View on Postman
\nImportant Variables:
\nbase_url: api.cushyaccess.com
auth_attribute: cushy-api-key
user_token: Your API key
This endpoint allows you to calculate the delivery charges based on the pickup and drop-off locations, as well as the type of vehicle used for delivery.
\nMethod: POST
\nURL: {{BASE_URL}}/api/v1/t/orders/calculate-delivery-charge
The request body should be in JSON format and contain the following parameters:
\npickUpLocation (string): The address where the delivery will be picked up from.
\ndropOffLocation (string): The address where the delivery will be dropped off.
\nvehicleType (string): The type of vehicle to be used for delivery (e.g., \"BIKE\").
\n{\n \"pickUpLocation\": \"4 Alh. Amoo St, Ojota, Lagos\",\n \"dropOffLocation\": \"Ogudu Mall Kosofe, Lagos\",\n \"vehicleType\": \"BIKE\"\n}\n\nThe response will be in JSON format and will include the following fields:
\nerror (boolean): Indicates whether there was an error in processing the request.
\nmessage (string): A message providing additional information about the error, if applicable.
\ndata (object): Contains the details of the delivery charge calculation.
\ntotalCharges (number): The total delivery charges calculated.
\nchargeNodes (array): An array of charge nodes, each containing:
\namount (number): The amount for the specific charge node.
\nname (string): The name of the charge node.
\ndistanceInKm (number): The distance from the pickup location to the drop-off location in kilometers.
\nduration (string): The estimated duration for the delivery.
\n{\n \"error\": true,\n \"message\": \"\",\n \"data\": {\n \"totalCharges\": 0,\n \"chargeNodes\": [\n {\n \"amount\": 0,\n \"name\": \"\"\n }\n ],\n \"distanceInKm\": 0,\n \"duration\": \"\"\n }\n}\n\nCalculating delivery charges for a bike:
\n{ \"pickUpLocation\": \"4 Alh. Amoo St, Ojota, Lagos\", \"dropOffLocation\": \"Ogudu Mall Kosofe, Lagos\", \"vehicleType\": \"BIKE\"}
\n{ \"error\": false, \"message\": \"\", \"data\": { \"totalCharges\": 1500, \"chargeNodes\": [ { \"amount\": 1500, \"name\": \"Base Charge\" } ], \"distanceInKm\": 5, \"duration\": \"15 mins\" }}
\nHandling an error in the request:
\nThis documentation provides a clear understanding of how to utilize the delivery charge calculation endpoint effectively.
\nThis endpoint calculates the delivery charge based on the provided pickup and drop-off locations, as well as the type of vehicle selected.
\nMethod: POST
\nURL: {{BASE_URL}}/api/v1/t/orders/calculate-delivery-charge
Content-Type: application/json
\nThe request body must be in JSON format and include the following parameters:
\npickUpLocation (string): The location where the delivery will start.
\ndropOffLocation (string): The destination location for the delivery.
\nvehicleType (string): The type of vehicle to be used for the delivery (e.g., BIKE).
\nExample Request Body:
\n{\n \"pickUpLocation\": \"4 Alh. Amoo St, Ojota, Lagos\",\n \"dropOffLocation\": \"Ogudu Mall Kosofe, Lagos\",\n \"vehicleType\": \"BIKE\"\n}\n\nStatus Code: 201 Created
\nContent-Type: application/json
\nThe response will be in JSON format and includes the following fields:
\nerror (boolean): Indicates if there was an error processing the request.
\nmessage (string): A message providing additional details about the error, if any.
\ndata (object): Contains the details of the calculated delivery charge.
\ntotalCharges (number): The total delivery charges calculated.
\nchargeNodes (array): An array of charge nodes detailing each charge.
\namount (number): The amount for each charge node.
\nname (string): The name of the charge node.
\ndistanceInKm (number): The distance of the delivery in kilometers.
\nduration (string): The estimated duration for the delivery.
\nExample Response:
\n{\n \"error\": true,\n \"message\": \"\",\n \"data\": {\n \"totalCharges\": 0,\n \"chargeNodes\": [\n {\n \"amount\": 0,\n \"name\": \"\"\n }\n ],\n \"distanceInKm\": 0,\n \"duration\": \"\"\n }\n}\n\nEnsure that the totalCharges is validated against expected values based on the pickup and drop-off locations and vehicle type.
\nValidate the chargeNodes to confirm that the amounts and names are populated correctly based on the delivery details provided.
\nThis endpoint allows users to create a delivery order by specifying the pickup and drop-off locations, vehicle type, sender and recipient information, package description, and delivery date.
\nMethod: POST
URL: {{BASE_URL}}/api/v1/t/orders/create-delivery-order
Content-Type: application/jsonThe request body must be in JSON format and contain the following parameters:
\npickUpLocation (string): The address where the package will be picked up.
\ndropOffLocation (string): The address where the package will be delivered.
\nvehicleType (string): The type of vehicle to be used for the delivery (e.g., BIKE).
\nsenderInfo (object): Information about the sender.
\nfullName (string): The full name of the sender.
\nphoneNumber (string): The phone number of the sender.
\nemailAddress (string): The email address of the sender.
\nrecipientInfo (object): Information about the recipient.
\nfullName (string): The full name of the recipient.
\nphoneNumber (string): The phone number of the recipient.
\nemailAddress (string): The email address of the recipient.
\npackageDescription (string): A description of the package being delivered.
\ndeliveryDate (string): The scheduled date and time for the delivery in ISO 8601 format.
\n{\n \"pickUpLocation\": \"4 Alh. Amoo St, Ojota, Lagos\",\n \"dropOffLocation\": \"Ogudu Mall Kosofe, Lagos\",\n \"vehicleType\": \"BIKE\",\n \"senderInfo\": {\n \"fullName\": \"John Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"emailAddress\": \"offorchukwuebuka11@gmail.com\"\n },\n \"recipientInfo\": {\n \"fullName\": \"Jane Smith\",\n \"phoneNumber\": \"+2348098765432\",\n \"emailAddress\": \"janesmith@example.com\"\n },\n \"packageDescription\": \"Small electronics (laptop, phone)\",\n \"deliveryDate\": \"2025-09-09T15:00:00Z\"\n}\n\nStatus Code: 201 Created
Content-Type: application/json
The response will contain a JSON object with the following structure:
\nerror (boolean): Indicates whether there was an error processing the request.
\nmessage (string): A message providing more details about the response.
\ndata (object): Contains information about the created delivery order.
\nuserId (string): The ID of the user who created the order.
\npickUpLocationAddress (string): The address of the pickup location.
\ndropOffLocationAddress (string): The address of the drop-off location.
\ntype (string): Type of delivery.
\nnoteForRider (string): Any notes for the rider.
\nnoteForVendor (string): Any notes for the vendor.
\ntotalItems (integer): Total number of items in the order.
\nitems (array): An array of items in the order.
\nduration (string): Estimated duration for the delivery.
\ntotalAmount (number): Total amount for the delivery.
\nrecipientInfo (object): Information about the recipient.
\nfullName (string): Full name of the recipient.
\nemailAddress (string): Email address of the recipient.
\nphoneNumber (string): Phone number of the recipient.
\nsenderInfo (object): Information about the sender.
\nfullName (string): Full name of the sender.
\nemailAddress (string): Email address of the sender.
\nphoneNumber (string): Phone number of the sender.
\nAdditional fields related to the order details.
\n{\n \"error\": true,\n \"message\": \"\",\n \"data\": {\n \"userId\": \"\",\n \"pickUpLocationAddress\": \"\",\n \"dropOffLocationAddress\": \"\",\n \"type\": \"\",\n \"noteForRider\": \"\",\n \"noteForVendor\": \"\",\n \"totalItems\": 0,\n \"items\": null,\n \"duration\": \"\",\n \"totalAmount\": 0,\n \"recipientInfo\": {\n \"fullName\": \"\",\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"senderInfo\": {\n \"fullName\": \"\",\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"id\": \"\",\n \"pickUpLocationId\": null,\n \"dropOffLocationId\": null,\n \"noteForStore\": null,\n \"totalAmountBeforeCharges\": null,\n \"Charges\": null,\n \"storeId\": null,\n \"scheduleDeliveryDate\": null,\n \"scheduleDeliveryTime\": null,\n \"buyForFriend\": null,\n \"fullHouseAddress\": null,\n \"additionalPhoneNumber\": null,\n \"scheduleDelivery\": true,\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}\n\nThis endpoint is essential for users looking to create delivery orders efficiently, providing all necessary details to ensure successful processing and tracking of deliveries.
\n","urlObject":{"path":["api","v1","t","orders","create-delivery-order"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0872382f-7e09-4d3f-8a93-53e915e01c3e","name":"Create Delivery Order","originalRequest":{"method":"POST","header":[{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"pickUpLocation\": \"4 Alh. Amoo St, Ojota, Lagos 105102, Lagos\",\n \"dropOffLocation\": \"Ogudu Mall Kosofe, Lagos\",\n \"vehicleType\": \"BIKE\",\n \n \"senderInfo\": {\n \"fullName\": \"John Doe\",\n \"phoneNumber\": \"+2348012345678\",\n \"emailAddress\": \"offorchukwuebuka11@gmail.com\"\n },\n \"recipientInfo\": {\n \"fullName\": \"Jane Smith\",\n \"phoneNumber\": \"+2348098765432\",\n \"emailAddress\": \"janesmith@example.com\"\n },\n \"packageDescription\": \"Small electronics (laptop, phone accessories)\",\n \"deliveryDate\": \"2025-09-09T15:00:00Z\"\n}\n"},"url":"{{BASE_URL}}/api/v1/t/orders/create-delivery-order"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"998"},{"key":"ETag","value":"W/\"3e6-sOFf+tPxCkmWDUxWVWiKzWjc94o\""},{"key":"Date","value":"Wed, 10 Sep 2025 14:53:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"ORDER_CREATED_SUCCESSFULLY\",\n \"data\": {\n \"userId\": \"usr_5c0709fc-6f8c-44a7-915a-84dbed3c6243\",\n \"pickUpLocationAddress\": \"4 Alh. Amoo St, Ojota, Lagos 105102, Lagos\",\n \"dropOffLocationAddress\": \"Ogudu Mall Kosofe, Lagos\",\n \"type\": \"LOGISTICS\",\n \"noteForRider\": \"\",\n \"noteForVendor\": \"\",\n \"totalItems\": 0,\n \"items\": null,\n \"duration\": \"5 mins\",\n \"totalAmount\": 506.73,\n \"recipientInfo\": {\n \"fullName\": \"Jane Smith\",\n \"emailAddress\": \"janesmith@example.com\",\n \"phoneNumber\": \"+2348098765432\"\n },\n \"senderInfo\": {\n \"fullName\": \"John Doe\",\n \"emailAddress\": \"offorchukwuebuka11@gmail.com\",\n \"phoneNumber\": \"+2348012345678\"\n },\n \"id\": \"ord_ec6b246c-9293-4816-bf10-4f3e695ae052\",\n \"pickUpLocationId\": null,\n \"dropOffLocationId\": null,\n \"noteForStore\": null,\n \"totalAmountBeforeCharges\": null,\n \"Charges\": null,\n \"storeId\": null,\n \"scheduleDeliveryDate\": null,\n \"scheduleDeliveryTime\": null,\n \"buyForFriend\": null,\n \"fullHouseAddress\": null,\n \"additionalPhoneNumber\": null,\n \"scheduleDelivery\": false,\n \"createdAt\": \"2025-09-10T13:52:56.536Z\",\n \"updatedAt\": \"2025-09-10T13:52:58.551Z\"\n }\n}"}],"_postman_id":"974cbdb2-6f2a-4863-a31b-09383c8b9451"},{"name":"Get Order By ID","id":"39457606-86ce-4326-8ab6-aebbcd064309","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"},{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"}],"url":"{{BASE_URL}}/api/v1/t/orders/get-order/ord_84089595-49a9-4244-9aed-66c9574d2457","urlObject":{"path":["api","v1","t","orders","get-order","ord_84089595-49a9-4244-9aed-66c9574d2457"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"993891a6-1be6-4345-af5b-7ac4e0612921","name":"Get Order By ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"},{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"}],"url":"{{BASE_URL}}/api/v1/t/orders/get-order/ord_84089595-49a9-4244-9aed-66c9574d2457"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1229"},{"key":"ETag","value":"W/\"4cd-SQv78InDP+Lx8/clqyCb3Mwq3vA\""},{"key":"Date","value":"Wed, 10 Sep 2025 14:54:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"ORDER_FETCHED_SUCCESSFULLY\",\n \"data\": {\n \"id\": \"ord_84089595-49a9-4244-9aed-66c9574d2457\",\n \"userId\": \"usr_5c0709fc-6f8c-44a7-915a-84dbed3c6243\",\n \"pickUpLocationId\": null,\n \"dropOffLocationId\": null,\n \"pickUpLocationAddress\": \"4 Alh. Amoo St, Ojota, Lagos 105102, Lagos\",\n \"dropOffLocationAddress\": \"Ogudu Mall Kosofe, Lagos\",\n \"type\": \"LOGISTICS\",\n \"noteForRider\": \"\",\n \"noteForVendor\": \"\",\n \"noteForStore\": null,\n \"totalItems\": 0,\n \"totalAmount\": \"506.73\",\n \"totalAmountBeforeCharges\": null,\n \"Charges\": null,\n \"storeId\": null,\n \"scheduleDelivery\": false,\n \"scheduleDeliveryDate\": null,\n \"scheduleDeliveryTime\": null,\n \"buyForFriend\": null,\n \"fullHouseAddress\": null,\n \"additionalPhoneNumber\": null,\n \"duration\": \"5 mins\",\n \"createdAt\": \"2025-09-09T20:58:34.798Z\",\n \"updatedAt\": \"2025-09-09T20:58:37.045Z\",\n \"items\": null,\n \"orderItems\": [],\n \"orderCharges\": {\n \"id\": \"sc_3d66dd18-0caf-4b5d-af98-57d0de544a76\",\n \"orderId\": \"ord_84089595-49a9-4244-9aed-66c9574d2457\",\n \"chargeNodes\": [\n {\n \"id\": \"orc_7775e4fd-c4c7-45ca-b219-76a458cab20d\",\n \"name\": \"deliveryFee\",\n \"amount\": \"306.73\",\n \"orderChargesId\": \"sc_3d66dd18-0caf-4b5d-af98-57d0de544a76\"\n },\n {\n \"id\": \"orc_10f20441-8a3b-4a1f-b2d0-3b225cb363b9\",\n \"name\": \"logisticServiceCharge\",\n \"amount\": \"200.00\",\n \"orderChargesId\": \"sc_3d66dd18-0caf-4b5d-af98-57d0de544a76\"\n }\n ]\n }\n }\n}"}],"_postman_id":"39457606-86ce-4326-8ab6-aebbcd064309"},{"name":"For Tracking Orders","event":[{"listen":"test","script":{"id":"47278c8d-d399-4e6b-bf2e-7f06e822cfc8","exec":["pm.test(\"Response status code is 200\", function () {\r"," pm.expect(pm.response.code).to.equal(200);\r","});\r","\r","\r","pm.test(\"Response time is less than 200ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","\r","pm.test(\"Response contains expected order status parameters\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.all.keys('error', 'message', 'data', 'pagination');\r"," \r"," const expectedStatuses = [\r"," \"PENDING\", \r"," \"ACKNOWLEDGED\", \r"," \"REJECTED\", \r"," \"PICKED_UP\", \r"," \"DELIVERED\", \r"," \"CANCELLED\", \r"," \"IN_PROGRESS\", \r"," \"ON_ROUTE\", \r"," \"RETURNED\", \r"," \"REFUNDED\", \r"," \"FAILED\", \r"," \"AWAITING_PAYMENT\", \r"," \"COMPLETED\"\r"," ];\r"," \r"," expectedStatuses.forEach(status => {\r"," pm.expect(responseData.data).to.not.include(status, `Status ${status} should not be present in the response data`);\r"," });\r","});\r","\r","\r","pm.test(\"Response headers include 'Content-Type' as 'application/json'\", function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","});\r","\r","pm.test(\"Response structure is valid\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.all.keys('error', 'message', 'data', 'pagination');\r"," \r"," pm.expect(responseData.error).to.be.a('boolean');\r"," pm.expect(responseData.message).to.be.a('string');\r"," pm.expect(responseData.data).to.be.an('array');\r"," \r"," pm.expect(responseData.pagination).to.be.an('object');\r"," pm.expect(responseData.pagination).to.have.all.keys('page', 'itemCount', 'totalItems', 'totalPages');\r"," pm.expect(responseData.pagination.page).to.be.a('number');\r"," pm.expect(responseData.pagination.itemCount).to.be.a('number');\r"," pm.expect(responseData.pagination.totalItems).to.be.a('number');\r"," pm.expect(responseData.pagination.totalPages).to.be.a('number');\r","});\r","\r","\r","pm.test(\"Response body has the expected schema\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.all.keys('error', 'message', 'data', 'pagination');\r"," \r"," pm.expect(responseData.error).to.be.a('boolean');\r"," pm.expect(responseData.message).to.be.a('string');\r"," \r"," pm.expect(responseData.data).to.be.an('array');\r"," \r"," pm.expect(responseData.pagination).to.be.an('object');\r"," pm.expect(responseData.pagination).to.have.all.keys('page', 'itemCount', 'totalItems', 'totalPages');\r"," \r"," pm.expect(responseData.pagination.page).to.be.a('number');\r"," pm.expect(responseData.pagination.itemCount).to.be.a('number');\r"," pm.expect(responseData.pagination.totalItems).to.be.a('number');\r"," pm.expect(responseData.pagination.totalPages).to.be.a('number');\r","});\r","// Stores the orderId in an environment or global variable\r","var responseData = pm.response.json();\r","if (responseData.data.length > 0) {\r"," var orderId = responseData.data[0].orderId; // Assuming orderId exists in the first element of data\r"," pm.globals.set(\"orderId\", orderId);\r","}"],"type":"text/javascript","packages":{}}}],"id":"08cc6e62-50e1-421a-b162-6f83f0ed9c34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"}],"url":"{{BASE_URL}}/api/v1/t/orders?page=1&size=10&filter[status]=ACKNOWLEDGED","description":"This endpoint retrieves a list of orders with support for pagination and filtering by status. The request allows you to specify which page of results to return, how many items per page, and filter the orders based on their status.
\nGET {{BASE_URL}}/api/v1/t/orders
page (integer): The page number of the results to retrieve. For example, page=1 retrieves the first page.
size (integer): The number of items to return per page. For example, size=10 returns 10 items.
filter[status] (string): A filter to retrieve orders with a specific status. In this case, setting filter[status]=ACKNOWLEDGED retrieves only those orders that have been acknowledged.
filter[status]=ACKNOWLEDGED
\nfilter[status]=DELIVERED
\nfilter[status]=PENDING
\nfilter[status]=REJECTED
\nfilter[status]=PICKED_UP
\nfilter[status]=CANCELLED
\nOn a successful request, the response will include the following structure:
\nerror (boolean): Indicates whether there was an error in the request.
\nmessage (string): A message providing additional information about the request status (may be empty).
\ndata (array): An array containing the retrieved orders. This will be empty if no orders match the criteria.
\npagination (object): Contains pagination information:
\npage (integer): The current page number.
\nitemCount (integer): The number of items returned in the current page.
\ntotalItems (integer): The total number of items available across all pages.
\ntotalPages (integer): The total number of pages available based on the specified page size.
\n{\n \"error\": true,\n \"message\": \"\",\n \"data\": [],\n \"pagination\": {\n \"page\": 0,\n \"itemCount\": 0,\n \"totalItems\": 0,\n \"totalPages\": 0\n }\n}\n\nThis response indicates that there are currently no acknowledged orders available.
\n","urlObject":{"path":["api","v1","t","orders"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"10"},{"key":"filter[status]","value":"ACKNOWLEDGED"}],"variable":[]}},"response":[{"id":"1e28901e-1e9b-42a6-b053-993219326c3d","name":"For Tracking Orders","originalRequest":{"method":"GET","header":[{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v1/t/orders?page=1&size=10&filter[status]=ACKNOWLEDGED","host":["{{BASE_URL}}"],"path":["api","v1","t","orders"],"query":[{"key":"page","value":"1"},{"key":"size","value":"10"},{"key":"filter[status]","value":"ACKNOWLEDGED"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"135"},{"key":"ETag","value":"W/\"87-jA5i1idOoL58xchpCdKCav4bKBw\""},{"key":"Date","value":"Wed, 10 Sep 2025 15:11:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"ORDERS_RETRIEVED_SUCCESSFULLY\",\n \"data\": [],\n \"pagination\": {\n \"page\": 1,\n \"itemCount\": 0,\n \"totalItems\": 0,\n \"totalPages\": 0\n }\n}"}],"_postman_id":"08cc6e62-50e1-421a-b162-6f83f0ed9c34"}],"id":"6a185175-d8a2-4648-8db4-445d7c025f9a","_postman_id":"6a185175-d8a2-4648-8db4-445d7c025f9a","description":""},{"name":"WALLET","item":[{"name":"Checking Wallet Balance","id":"b3769855-3d93-4ddb-8769-6d557b2d201d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"}],"url":"{{BASE_URL}}/api/v1/t/wallet","description":"This API endpoint retrieves information about the user's wallet.
\nMethod: GET
\nURL: {{BASE_URL}}/api/v1/t/wallet
Status Code: 200
\nContent-Type: application/json
\nThe response body contains the following fields:
\nerror (boolean): Indicates if there was an error with the request.
\nmessage (string): A message providing additional information about the error, if any.
\ndata (object): Contains wallet details:
\nid (string): The unique identifier for the wallet.
\naccountBalance (number): The current balance of the wallet.
\nhasSetPin (boolean): Indicates whether a PIN has been set for the wallet.
\nlastTwoTransactions (array): An array of the last two transactions, where each transaction includes:
\nid (string): The unique identifier for the transaction.
\namount (number): The amount of the transaction.
\ntype (string): The type of transaction (e.g., credit, debit).
\ndate (string): The date of the transaction.
\nstatus (string): The current status of the transaction.
\norderId (string or null): The identifier for the associated order, if applicable.
\nA low account balance may prevent users from making deliveries or creating any post requests.
\n","urlObject":{"path":["api","v1","t","wallet"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"210dfb72-815e-4772-b7a1-2f9afbdf01a4","name":"Checking Wallet Balance","originalRequest":{"method":"GET","header":[{"key":"cushy-api-key","value":"CUSHY-06bbc6d3125b12cad6494a46c9c531b94d3f411fbfd68f483a4124804c2d1800-X","type":"text"}],"url":"{{BASE_URL}}/api/v1/t/wallet"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"488"},{"key":"ETag","value":"W/\"1e8-UY7LU/yesFT1fQdEyLWqubf73I8\""},{"key":"Date","value":"Wed, 10 Sep 2025 14:53:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"message\": \"WALLET_FETCHED_SUCCESSFULLY\",\n \"data\": {\n \"id\": \"wa_509a8351-fac6-40b7-9d08-f84557625e47\",\n \"accountBalance\": 98479.81,\n \"hasSetPin\": false,\n \"lastTwoTransactions\": [\n {\n \"id\": \"trn_13f41ab3-b1b2-4d09-b9e1-3c271c345912\",\n \"amount\": 506.73,\n \"type\": \"LOGISTICS\",\n \"date\": \"2025-09-10T13:52:59.726Z\",\n \"status\": \"completed\",\n \"orderId\": null\n },\n {\n \"id\": \"trn_093394b2-622b-4a9c-885e-ff2d79deca74\",\n \"amount\": 506.73,\n \"type\": \"LOGISTICS\",\n \"date\": \"2025-09-10T13:50:27.456Z\",\n \"status\": \"completed\",\n \"orderId\": null\n }\n ]\n }\n}"}],"_postman_id":"b3769855-3d93-4ddb-8769-6d557b2d201d"},{"name":"Get Transactions","id":"607faa6c-0bda-4a96-985e-d5b9338f7cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"{{auth_attribute}}","value":"{{user_token}}","type":"text"}],"url":"{{base_url}}/api/v1/t/wallet/transactions?filter[status]=completed","urlObject":{"path":["api","v1","t","wallet","transactions"],"host":["{{base_url}}"],"query":[{"description":{"content":"This is the transaction status, which can be completed,pending, await_delivery, failed, reversed
\n","type":"text/plain"},"key":"filter[status]","value":"completed"}],"variable":[]}},"response":[{"id":"81c6e26b-0293-4bb7-b100-605b95c0348b","name":"success [200]","originalRequest":{"method":"GET","header":[{"key":"{{auth_attribute}}","value":"{{user_token}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/t/wallet/transactions?filter[status]=completed","host":["{{base_url}}"],"path":["api","v1","t","wallet","transactions"],"query":[{"key":"filter[status]","value":"completed","description":"This is the transaction status, which can be completed,pending, await_delivery, failed, reversed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"286"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 08 Aug 2025 20:51:43 GMT"},{"key":"Etag","value":"W/\"11e-XkIKaUqfChBUKCd7uVn8HJkWgNk\""},{"key":"Ngrok-Agent-Ips","value":"105.112.101.76"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"TRANSACTION_FETCHED_SUCCESSFULLY\",\n \"data\": [\n {\n \"id\": \"trn_ec7ffb28-2cab-45a4-9be8-2c851e503189\",\n \"amount\": 1000,\n \"type\": \"DEBIT\",\n \"date\": \"2025-08-08T19:50:59.377Z\",\n \"status\": \"completed\",\n \"orderId\": null\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"itemCount\": 1,\n \"totalItems\": 1,\n \"totalPages\": 1\n }\n}"}],"_postman_id":"607faa6c-0bda-4a96-985e-d5b9338f7cb0"},{"name":"Get Transaction Details","id":"825a042f-079b-49fd-954b-b68a7184641d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"{{auth_attribute}}","value":"{{user_token}}","type":"text"}],"url":"{{base_url}}/api/v1/t/wallet/transactions/{{transaction_id}}","urlObject":{"path":["api","v1","t","wallet","transactions","{{transaction_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"341e9cc0-57ee-4e62-8ef5-410fcf8b0a47","name":"success [200]","originalRequest":{"method":"GET","header":[{"key":"{{auth_attribute}}","value":"{{user_token}}","type":"text"}],"url":"{{base_url}}/api/v1/t/wallet/transactions/{{transaction_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"622"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 08 Aug 2025 20:54:54 GMT"},{"key":"Etag","value":"W/\"26e-YZj513fHJ9FRHthU3Ki97O1uXeg\""},{"key":"Ngrok-Agent-Ips","value":"105.112.101.76"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"message\": \"TRANSACTION_FETCHED_SUCCESSFULLY\",\n \"data\": {\n \"id\": \"trn_ec7ffb28-2cab-45a4-9be8-2c851e503189\",\n \"transactionReference\": \"CATX-353cc20f-3cca-474d-834b-a0d094c74f70\",\n \"status\": \"completed\",\n \"recipientUserId\": \"usr_f1aa18c9-6166-4023-95b9-65772d6fb207\",\n \"recipientFirstName\": \"Test-4\",\n \"recipientLastName\": \"Store Setup\",\n \"receiptEmail\": \"store.setup8@gmail.com\",\n \"senderFirstName\": \"Ummis\",\n \"senderLastName\": \"AA\",\n \"senderEmail\": \"ummis@gmail.com\",\n \"transactionAmount\": 1000,\n \"category\": \"DEBIT\",\n \"description\": \"SEND_FUNDS\",\n \"createAt\": \"2025-08-08T19:50:59.377Z\",\n \"updatedAt\": \"2025-08-08T19:50:59.377Z\",\n \"thirpartySenderInfo\": {}\n }\n}"}],"_postman_id":"825a042f-079b-49fd-954b-b68a7184641d"},{"name":"Get Virtual Account","id":"a5e852f0-799c-4699-b9f0-e808d54f60db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"{{auth_attribute}}","value":"{{user_token}}","type":"text"}],"url":"{{base_url}}/api/v1/t/wallet/virtual-account/{{wallet_id}}","urlObject":{"path":["api","v1","t","wallet","virtual-account","{{wallet_id}}"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"ee0d615f-917d-4462-a6a0-9bf412f1f5f2","name":"success [200]","originalRequest":{"method":"GET","header":[{"key":"{{auth_attribute}}","value":"{{user_token}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/t/wallet/virtual-account/{{wallet_id}}","host":["{{base_url}}"],"path":["api","v1","t","wallet","virtual-account","{{wallet_id}}"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"270"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 08 Aug 2025 20:55:40 GMT"},{"key":"Etag","value":"W/\"10e-2ymAaG/ZV58PcILHt71mSZhzMRg\""},{"key":"Ngrok-Agent-Ips","value":"105.112.101.76"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"VIRTUAL_ACCOUNT_FETCHED\",\n \"data\": {\n \"id\": \"va_cddd01c1-9277-433a-8b46-0bf7dd52f227\",\n \"accountName\": \"CUSHYACCESS/AA UMMIS\",\n \"accountNumber\": \"9341111077\",\n \"bank\": \"Wema Bank\",\n \"createdAt\": \"2025-08-06T20:19:33.675Z\",\n \"updatedAt\": \"2025-08-06T20:19:33.675Z\"\n }\n}"}],"_postman_id":"a5e852f0-799c-4699-b9f0-e808d54f60db"}],"id":"984d5600-f4de-4951-86d2-9d390411cfc2","_postman_id":"984d5600-f4de-4951-86d2-9d390411cfc2","description":""},{"name":"Health Check","id":"78c53dc8-6e68-4dc7-8bd6-c4b9691c13a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/health-check","urlObject":{"path":["api","v1","health-check"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"78c53dc8-6e68-4dc7-8bd6-c4b9691c13a8"}],"event":[{"listen":"prerequest","script":{"id":"acbb0295-85aa-4e1c-967e-419a39f650d0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d7a1fb02-453d-4136-8ce0-8da31f397676","type":"text/javascript","packages":{},"exec":[""]}}]}