Open invoice list
Retrieves and displays all active or unpaid invoices that are still open for customer payments
GET
Base URL
Sandbox Base URL
Strictly for sandbox testing. Never use the sandbox URL in your production environment.
https://merchantapisandbox.hesabe.com
bearerAuthheader
AuthorizationBearer <JWT>Pass access token obtained from login endpoint
accessCode*stringPass the merchant access code issued by Hesabe
Accept*stringapplication/json
Content-Type*stringapplication/json
toDate*stringPass the to date (YYYY-MM-DD)
fromDate*stringPass the from date (YYYY-MM-DD)
page*numberPass the pagination number
search?stringPass the search string
data*stringConvert payload JSON object to encrypted string and send it to the server
Query parameter details:
| Field Name | Description | Required |
|---|---|---|
fromDate | Pass the start date (YYYY-MM-DD) | Yes |
toDate | Pass the end date (YYYY-MM-DD) | Yes |
page | Pass the pagination number, defalut is "1" | Yes |
data | Pass the merchant code provided by Hesabe as an encrypted string | Yes |
search | Pass the search string | Optional |
Sample Encryption and Decryption Process:
The following steps demonstrate how to integrate with this API using sandbox credentials.
Step 1: Create JSON Object
{ "merchantCode": "842217"}Step 2: Convert the JSON object into an encrypted string format and post to Hesabe
{ "data": "0e7898bd7464d0c402fe8a949d9cbf9b826ccb9b83b56fa003373275f1947a65"}Step 3: Receive encrypted response from Hesabe:
{ "response": "60a8f6241932227b840a9f5e36987f4df645edae356a969d3dd7123d8946484ae77cbe23c68e9505e794d2fb1505e2675e4fd6cb24b911287905d0cafda7db01f6e095558c4f625637d86121281b2a1b73ed451614993310fee8ed1621f8b8f9d9e428c4e24325d2b842896df734e2463ad92b104b7549d231b638a5b0ca2dbc6894631ca5d167a651d2f821f3c0ea87477ca654a7dbfd5888bb9fb5e8eaa5fcaff0e45c33c2a0767e8a22a2c0bfb7d5a38d678ba08750e224d43de7e6b4dcfab810f3b42018e9849166d6241f7b7c8c93d95e27900e43f4494bd95d265a9c7b64d94ca7c765ef9d3cd1b54a327b48722ffc282517332a1cbb2104703de06858c0057bba1ee3382c9bf541a271eb4bd0ce272d44dbf259a34f8a08b5b9bf312b4ae221f7db290a60cbc9d117ac846c1455eda6a14e322a805d4ad702470a7498789df92485ec23d78ba8e79863990a0f12e4bb9b35c9c73ace0bb6eb09bc8ab288198c832ad99ff653209584d2999703c9ce8c6d3fc5a21f35491b4bb8656171fe144aa502924ae84503c1f4597d0a958fdaaa0427e46a59ef059cfe550534a2cd907f6ff341feda75ecbab143cbf59b0e91e232dc76e48ab1fe1bfdfcb266df24ef1eb5cbf66dc1beed79f59607a8c201840ae03e828746d887f724620def7c2a6d53ef764cee5f8cc71e2f8e2cc390395d3d4ad8ecf892b6f460884ec8079f91b97ea2370a13a1f0ce1939eb2ac96e12b92e9f6e3927cb115da798fc94146bc65b5253968a2724f0b1f5c767a1ca8a8064a300d27a859d77b7d0e6139515ead963eac1c8e3eb85afca208258cca8b6a145b7321e93205ddb4d93a6f9d37837449d83bc158355681246aca410d465ba9af66c97c07dc997cbadcbf5b0e660b268e73e458093b62ed66093c16db4df54a5af3ae08c0f1db29dcb8259f4552cd6e50a242874be8b91f0449d7a833771c72c0a242187b9278b5a5464d25b6b5cab503df55ac6caa9b7fb7a8f1ce76769c9f92df1e5b968de2b35eb7026a4f249ff2fb2dd6c1485001bf33605ea694281e2da2acabcdf4c2d3653d54d6a0f058facb10858d6ef862d102da3401b83db0384e7651c4fed9ee40ca44018082a99dc31f1ee4cd9644efb64c6248ad09c6139e61510ac9dcbf1622321a78480f579a0978e3a5d170dbd8d4b5a425a0ed7ea05e6a87ea0b6355c1d66ef1931c8f04340f60bef2640cffba7e2b65d003c8fa187a87c9974b6fe4bb19475d4244d62d8acb51bdcefbf23bd638ecec82930b4bb616680ca400bd28a78c343525cf4506f8f1c6645425445a05c84eb2e5aef0597559c7a57e7939e5e55c6d8164a67ccfdb5bd84513b6b5325f901e6044a8d94acf3cacb4a846c6185a7d0f87db9e16aa6ce9d8a526b42c58508cfe6944297602e2aa5dc712bb96955ab3c26ebc02d4d9c62ac83e16e39479d4b985c8e327001357b09e5b44c999e9a650850f158a93a9299bd3bafc48de3da345f9726204283cda958461f96a132108d182482e836e94d5352d8cd5b33c69188ef4093af543acf190248fe73f3ee447b7e7440e70936b8ce9768b5ab3605092b4889e958040d9d79646e94429febfa1bea518eed3281222ac941cc3ead10994d16e07c5b458045568f495efee968a28bfd50901b017255298ed037f0eb71e1b1fa1607f85c3acb9f254a702a871da63400efb2deb0e3bc039665661b1a87aafe6b75490104fdc9cc72f5f4c2fc115803977257a46960a9da5902bdf125afc2a4241c9913fdcb7ea8324797441fd615e66eccdf749f08512c5a2a035a0020c51014b62b2e29d3fae33ff9b6c6570a0ff103513eff4b94214a2954fa3bffd2d6d5e28c6888f09ce33264e09b4d156dda431a6d000412a2c5cbe1f9b160f5654091d6510e2c9cd5a18263b9b99e4bca207e3075442d08225bb34db7ae0b6df5e30e7c98f2446df01b26562eb15dfc14f994b62804c36ca9e48d7368b847682705266d32f1ba0bee71a0afc147fc694a9f80e1777aec0f3677db1d512d3307c0f3651c3160bebb60da746f802105fec96c0e24482708afe69d3c540ae56425df5b05ecd5388591d5bfa550445e68372bfb0f1ef29167ad4c01eb9f49c18974d1d22dd26929050c31454828730e24fed416041fd41c16ed212e8d2d338543511a9ae2999fa6ba540945e79b0da30e48fb28d16121f494bfa4fad6cf3aa0b67cd08197bba1eb26de5689bdd1e995d80d2a50f4aa82e1970aa9c21c46662279b3d213d12bad04ea0bde06d0f0c03645c8d1be2b3949f85aaab4bb43830acf9c35595208acfba7fca9493e7f9702d3ffa519ffea5c2b09f07676c2b0386253bcfdf7406494dbd1a55f16e649bdcd013c5280aa5118015e8ce9fc9023241780022d9babf26b1f684f5938685f10d4caf098f6ecc3fcfee50eed638646f56d2fc0e4750e3da76a563f80f82e079c1cee53bf02ad4ce3d95a4bb2be098ffb71bb0c708fa117d396320583a2b16876da8c9e90b0ad1a7274a0dae7f4680be3cee12c699e192732cea03891c16e34a6a616a5c62bc677c5d56104034ff716a4b237d817a4bbf1cc417a904aa79e7d92d1811a1a48c639bd5908044d8aeb929ed2e6eef651e1b80f5d37ed0ed190e15a1bdb728ad619af03be3f08305e6fdf93"}Step 4: Decrypt the API response and view the JSON output
{ "status": true, "message": "Open Invoice List", "response": { "data": [ { "id": 926, "merchant_id": 84, "title": "Test", "reference_number": "8417599190409846769370", "type": 0, "description": "testing open invoice", "fixed_amount": "100.000", "min_amount": "0.000", "max_amount": "0.000", "paid_status": 0, "status": 0, "created_by": 84, "created_at": "2025-10-08 13:24:00", "updated_at": "2025-10-08 13:24:00", "expiry_date": "2026-12-05", "url": "https://merchant.hesbstaging.com/open-invoice/checkout/8417599190409846769370", "total_amount_customer_paid": "0.000", "total_customer_tried_count": 0, "total_customer_paid_count": 0 }, { "id": 925, "merchant_id": 84, "title": "Test", "reference_number": "841759918478936761485", "type": 0, "description": "testing open invoice", "fixed_amount": "100.000", "min_amount": "0.000", "max_amount": "0.000", "paid_status": 0, "status": 0, "created_by": 84, "created_at": "2025-10-08 13:14:38", "updated_at": "2025-10-08 13:14:38", "expiry_date": "2026-12-05", "url": "https://merchant.hesbstaging.com/open-invoice/checkout/841759918478936761485", "total_amount_customer_paid": "0.000", "total_customer_tried_count": 0, "total_customer_paid_count": 0 }, { "id": 924, "merchant_id": 84, "title": "Test", "reference_number": "84175991794397745669933", "type": 0, "description": "testing open invoice", "fixed_amount": "100.000", "min_amount": "0.000", "max_amount": "0.000", "paid_status": 0, "status": 0, "created_by": 84, "created_at": "2025-10-08 13:05:43", "updated_at": "2025-10-08 13:05:43", "expiry_date": "2026-12-05", "url": "https://merchant.hesbstaging.com/open-invoice/checkout/84175991794397745669933", "total_amount_customer_paid": "0.000", "total_customer_tried_count": 0, "total_customer_paid_count": 0 } ], "pagination": { "total": 3, "count": 3, "per_page": 15, "current_page": 1, "total_pages": 1, "page_url": "https://merchantapisandbox.hesabe.com/api/v1/open-invoice", "next_page_url": null, "previous_page_url": null } }}Details fetched successfully. Decrypt the server response to view the final result
application/json- response
status?booleanmessage?stringresponse?fetch("https://merchantapisandbox.hesabe.com/api/v1/open-invoice/?toDate=2025-10-08&fromDate=2025-10-06&page=1&data=0e7898bd7464d0c402fe8a949d9cbf9b826ccb9b83b56fa003373275f1947a65", { method: "GET", headers: { "accessCode": "c333729b-d060-4b74-a49d-7686a8353481", "Accept": "application/json", "Content-Type": "application/json" }})Example Response
{ "status": true, "message": "Open Invoice List", "response": { "data": [ { "id": 926, "merchant_id": 84, "title": "Test", "reference_number": "8417599190409846769370", "type": 0, "description": "testing open invoice", "fixed_amount": "100.000", "min_amount": "0.000", "max_amount": "0.000", "paid_status": 0, "status": 0, "created_by": 84, "created_at": "2025-10-08 13:24:00", "updated_at": "2025-10-08 13:24:00", "expiry_date": "2026-12-05", "url": "https://merchant.hesbstaging.com/open-invoice/checkout/8417599190409846769370", "total_amount_customer_paid": "0.000", "total_customer_tried_count": 0, "total_customer_paid_count": 0 } ], "pagination": { "total": 3, "count": 3, "per_page": 15, "current_page": 1, "total_pages": 1, "page_url": "https://merchantapisandbox.hesabe.com/api/v1/open-invoice", "next_page_url": null, "previous_page_url": null } }}