[{"data":1,"prerenderedAt":765},["ShallowReactive",2],{"docs-nav":3,"content:\u002Fapi\u002Fbalances":78},[4,18,29,35,46,63,66,69,72,75],{"path":5,"title":6,"navTitle":6,"order":7,"subnav":8},"\u002Fapi\u002Fapi-tokens","API tokens",3,[9,12,15],{"title":10,"anchor":11},"Create an API key","create-an-api-key",{"title":13,"anchor":14},"List API keys","list-api-keys",{"title":16,"anchor":17},"Revoke an API key","revoke-an-api-key",{"path":19,"title":20,"navTitle":20,"order":21,"subnav":22},"\u002Fapi\u002Fbalances","Balances",4,[23,26],{"title":24,"anchor":25},"The balance object","the-balance-object",{"title":27,"anchor":28},"List balances","list-balances",{"path":30,"title":31,"navTitle":32,"order":33,"subnav":34},"\u002Fapi","API overview","Overview",1,null,{"path":36,"title":37,"navTitle":37,"order":38,"subnav":39},"\u002Fapi\u002Fsender-ids","Sender IDs",5,[40,43],{"title":41,"anchor":42},"The sender identity object","the-sender-identity-object",{"title":44,"anchor":45},"List sender IDs","list-sender-ids",{"path":47,"title":48,"navTitle":48,"order":49,"subnav":50},"\u002Fapi\u002Fsms","SMS",2,[51,54,57,60],{"title":52,"anchor":53},"The message object","the-message-object",{"title":55,"anchor":56},"Send an SMS","send-an-sms",{"title":58,"anchor":59},"Retrieve an SMS","retrieve-an-sms",{"title":61,"anchor":62},"Send bulk SMS","send-bulk-sms",{"path":64,"title":65,"navTitle":65,"order":49,"subnav":34},"\u002Fguides\u002Fauthentication","Authentication",{"path":67,"title":68,"navTitle":68,"order":7,"subnav":34},"\u002Fguides\u002Fbulk-sms","Bulk SMS",{"path":70,"title":71,"navTitle":71,"order":38,"subnav":34},"\u002Fguides\u002Fmcp","AI agents (MCP)",{"path":73,"title":74,"navTitle":74,"order":33,"subnav":34},"\u002Fguides\u002Fquickstart","Quickstart",{"path":76,"title":77,"navTitle":77,"order":21,"subnav":34},"\u002Fguides\u002Fwebhooks","Webhooks",{"id":79,"path":19,"title":20,"description":80,"navTitle":20,"order":21,"wide":81,"body":82,"seo":761,"stem":762,"extension":763,"meta":764,"navigation":81},"content\u002Fapi\u002Fbalances.md","Read your prepaid wallet balances programmatically — one row per currency, in the same ten-thousandths unit as charge.",true,{"type":83,"value":84,"toc":757},"minimark",[85,94,97,229,231,236,753],[86,87,88,89,93],"p",{},"Accounts are prepaid: every send places a hold, and a send your balance will not cover is\nrejected outright — never half-delivered. A ",[90,91,92],"strong",{},"balance"," is what you hold in one currency;\nthe account carries one row per currency.",[95,96,24],"h2",{"id":25},[98,99,100,163],"row",{},[101,102,103,108,152],"column",{},[104,105,107],"h3",{"id":106},"attributes","Attributes",[109,110,111,119,143],"properties",{},[112,113,116],"property",{"name":114,"type":115},"id","string (uuid)",[86,117,118],{},"Balance row id.",[112,120,123],{"name":121,"type":122},"amount","integer",[86,124,125,126,130,131,134,135,138,139,142],{},"What you hold, in ten-thousandths of ",[127,128,129],"code",{},"currency"," — the same unit as ",[127,132,133],{},"charge","\n(",[127,136,137],{},"10000"," == 1.00, so ",[127,140,141],{},"1250000"," == 125.00).",[112,144,146],{"name":129,"type":145},"string",[86,147,148,149,151],{},"Currency of ",[127,150,121],{},".",[86,153,154,155,158,159,162],{},"Rows may carry additional fields (",[127,156,157],{},"type",", ",[127,160,161],{},"active","); treat anything beyond the three above\nas informational.",[101,164,166],{":sticky":165},"true",[167,168,169],"code-group",{"title":24},[170,171,177],"pre",{"className":172,"code":173,"filename":174,"language":175,"meta":176,"style":176},"language-json shiki shiki-themes github-light github-dark","{\n  \"id\": \"5b1c8f2e-3d47-4a09-9c6b-2e8f1a7d4c5e\",\n  \"amount\": 1250000,\n  \"currency\": \"USD\"\n}\n","Balance","json","",[127,178,179,187,203,214,224],{"__ignoreMap":176},[180,181,183],"span",{"class":182,"line":33},"line",[180,184,186],{"class":185},"sVt8B","{\n",[180,188,189,193,196,200],{"class":182,"line":49},[180,190,192],{"class":191},"sj4cs","  \"id\"",[180,194,195],{"class":185},": ",[180,197,199],{"class":198},"sZZnC","\"5b1c8f2e-3d47-4a09-9c6b-2e8f1a7d4c5e\"",[180,201,202],{"class":185},",\n",[180,204,205,208,210,212],{"class":182,"line":7},[180,206,207],{"class":191},"  \"amount\"",[180,209,195],{"class":185},[180,211,141],{"class":191},[180,213,202],{"class":185},[180,215,216,219,221],{"class":182,"line":21},[180,217,218],{"class":191},"  \"currency\"",[180,220,195],{"class":185},[180,222,223],{"class":198},"\"USD\"\n",[180,225,226],{"class":182,"line":38},[180,227,228],{"class":185},"}\n",[95,230,27],{"id":28},[232,233],"endpoint",{"method":234,"path":235},"GET","\u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fbalances",[98,237,238,335],{},[101,239,240,253,263,267,286,290,301,305],{},[86,241,242,243,248,249,252],{},"Reads the account's balances, one row per currency, with the same API key as everything\nelse. Check it before a ",[244,245,247],"a",{"href":246},"\u002Fapi\u002Fsms#send-bulk-sms","bulk send"," rather than discovering\n",[127,250,251],{},"422 insufficient balance"," mid-launch.",[86,254,255,256,259,260,151],{},"This is the endpoint behind the hosted MCP server's ",[127,257,258],{},"get_balance"," tool — see\n",[244,261,262],{"href":70},"AI agents",[104,264,266],{"id":265},"path-parameters","Path parameters",[109,268,269],{},[112,270,271],{"name":114,"type":115,":required":165},[86,272,273,274,278,279,282,283,151],{},"Your account id. It is on the ",[244,275,277],{"href":276},"\u002Fapi\u002Fapi-tokens#create-an-api-key","key create response"," as\n",[127,280,281],{},"account_id",", and on every row of the key listing as ",[127,284,285],{},"AccountId",[104,287,289],{"id":288},"response","Response",[86,291,292,293,296,297,151],{},"Enveloped: ",[127,294,295],{},"data"," is an array of ",[244,298,300],{"href":299},"#the-balance-object","balance objects",[104,302,304],{"id":303},"errors","Errors",[306,307,308,321],"table",{},[309,310,311],"thead",{},[312,313,314,318],"tr",{},[315,316,317],"th",{},"Status",[315,319,320],{},"When",[322,323,324],"tbody",{},[312,325,326,332],{},[327,328,329],"td",{},[127,330,331],{},"401",[327,333,334],{},"Missing, malformed, or revoked API key.",[101,336,337,659],{":sticky":165},[167,338,341,375,516],{"title":339,"label":340},"Request","GET \u002Fapi\u002Fv1\u002Faccounts\u002F{id}\u002Fbalances",[170,342,347],{"className":343,"code":344,"filename":345,"language":346,"meta":176,"style":176},"language-bash shiki shiki-themes github-light github-dark","curl https:\u002F\u002Fapi.sendai.co.zw\u002Fapi\u002Fv1\u002Faccounts\u002F2d6f4b8e-1a90-4e21-8b7d-3f1a5c2e9a0c\u002Fbalances \\\n  -H \"Authorization: Bearer $SENDAI_API_KEY\"\n","cURL","bash",[127,348,349,361],{"__ignoreMap":176},[180,350,351,355,358],{"class":182,"line":33},[180,352,354],{"class":353},"sScJk","curl",[180,356,357],{"class":198}," https:\u002F\u002Fapi.sendai.co.zw\u002Fapi\u002Fv1\u002Faccounts\u002F2d6f4b8e-1a90-4e21-8b7d-3f1a5c2e9a0c\u002Fbalances",[180,359,360],{"class":191}," \\\n",[180,362,363,366,369,372],{"class":182,"line":49},[180,364,365],{"class":191},"  -H",[180,367,368],{"class":198}," \"Authorization: Bearer ",[180,370,371],{"class":185},"$SENDAI_API_KEY",[180,373,374],{"class":198},"\"\n",[170,376,381],{"className":377,"code":378,"filename":379,"language":380,"meta":176,"style":176},"language-js shiki shiki-themes github-light github-dark","const accountId = '2d6f4b8e-1a90-4e21-8b7d-3f1a5c2e9a0c'\n\nconst res = await fetch(\n  `https:\u002F\u002Fapi.sendai.co.zw\u002Fapi\u002Fv1\u002Faccounts\u002F${accountId}\u002Fbalances`,\n  { headers: { 'Authorization': `Bearer ${process.env.SENDAI_API_KEY}` } },\n)\n\nconst { data: balances } = await res.json()\n\u002F\u002F amount is in ten-thousandths: 1250000 == 125.00\n","Node.js","js",[127,382,383,398,403,421,434,466,472,477,509],{"__ignoreMap":176},[180,384,385,389,392,395],{"class":182,"line":33},[180,386,388],{"class":387},"szBVR","const",[180,390,391],{"class":191}," accountId",[180,393,394],{"class":387}," =",[180,396,397],{"class":198}," '2d6f4b8e-1a90-4e21-8b7d-3f1a5c2e9a0c'\n",[180,399,400],{"class":182,"line":49},[180,401,402],{"emptyLinePlaceholder":81},"\n",[180,404,405,407,410,412,415,418],{"class":182,"line":7},[180,406,388],{"class":387},[180,408,409],{"class":191}," res",[180,411,394],{"class":387},[180,413,414],{"class":387}," await",[180,416,417],{"class":353}," fetch",[180,419,420],{"class":185},"(\n",[180,422,423,426,429,432],{"class":182,"line":21},[180,424,425],{"class":198},"  `https:\u002F\u002Fapi.sendai.co.zw\u002Fapi\u002Fv1\u002Faccounts\u002F${",[180,427,428],{"class":185},"accountId",[180,430,431],{"class":198},"}\u002Fbalances`",[180,433,202],{"class":185},[180,435,436,439,442,444,447,450,452,455,457,460,463],{"class":182,"line":38},[180,437,438],{"class":185},"  { headers: { ",[180,440,441],{"class":198},"'Authorization'",[180,443,195],{"class":185},[180,445,446],{"class":198},"`Bearer ${",[180,448,449],{"class":185},"process",[180,451,151],{"class":198},[180,453,454],{"class":185},"env",[180,456,151],{"class":198},[180,458,459],{"class":191},"SENDAI_API_KEY",[180,461,462],{"class":198},"}`",[180,464,465],{"class":185}," } },\n",[180,467,469],{"class":182,"line":468},6,[180,470,471],{"class":185},")\n",[180,473,475],{"class":182,"line":474},7,[180,476,402],{"emptyLinePlaceholder":81},[180,478,480,482,485,488,490,493,496,499,501,504,506],{"class":182,"line":479},8,[180,481,388],{"class":387},[180,483,484],{"class":185}," { ",[180,486,295],{"class":487},"s4XuR",[180,489,195],{"class":185},[180,491,492],{"class":191},"balances",[180,494,495],{"class":185}," } ",[180,497,498],{"class":387},"=",[180,500,414],{"class":387},[180,502,503],{"class":185}," res.",[180,505,175],{"class":353},[180,507,508],{"class":185},"()\n",[180,510,512],{"class":182,"line":511},9,[180,513,515],{"class":514},"sJ8bj","\u002F\u002F amount is in ten-thousandths: 1250000 == 125.00\n",[170,517,522],{"className":518,"code":519,"filename":520,"language":521,"meta":176,"style":176},"language-python shiki shiki-themes github-light github-dark","import os\nimport requests\n\naccount_id = \"2d6f4b8e-1a90-4e21-8b7d-3f1a5c2e9a0c\"\n\nres = requests.get(\n    f\"https:\u002F\u002Fapi.sendai.co.zw\u002Fapi\u002Fv1\u002Faccounts\u002F{account_id}\u002Fbalances\",\n    headers={\"Authorization\": f\"Bearer {os.environ['SENDAI_API_KEY']}\"},\n)\n\nbalances = res.json()[\"data\"]\n# amount is in ten-thousandths: 1250000 == 125.00\n","Python","python",[127,523,524,532,539,543,553,557,567,588,627,631,636,653],{"__ignoreMap":176},[180,525,526,529],{"class":182,"line":33},[180,527,528],{"class":387},"import",[180,530,531],{"class":185}," os\n",[180,533,534,536],{"class":182,"line":49},[180,535,528],{"class":387},[180,537,538],{"class":185}," requests\n",[180,540,541],{"class":182,"line":7},[180,542,402],{"emptyLinePlaceholder":81},[180,544,545,548,550],{"class":182,"line":21},[180,546,547],{"class":185},"account_id ",[180,549,498],{"class":387},[180,551,552],{"class":198}," \"2d6f4b8e-1a90-4e21-8b7d-3f1a5c2e9a0c\"\n",[180,554,555],{"class":182,"line":38},[180,556,402],{"emptyLinePlaceholder":81},[180,558,559,562,564],{"class":182,"line":468},[180,560,561],{"class":185},"res ",[180,563,498],{"class":387},[180,565,566],{"class":185}," requests.get(\n",[180,568,569,572,575,578,580,583,586],{"class":182,"line":474},[180,570,571],{"class":387},"    f",[180,573,574],{"class":198},"\"https:\u002F\u002Fapi.sendai.co.zw\u002Fapi\u002Fv1\u002Faccounts\u002F",[180,576,577],{"class":191},"{",[180,579,281],{"class":185},[180,581,582],{"class":191},"}",[180,584,585],{"class":198},"\u002Fbalances\"",[180,587,202],{"class":185},[180,589,590,593,595,597,600,602,605,608,610,613,616,619,621,624],{"class":182,"line":479},[180,591,592],{"class":487},"    headers",[180,594,498],{"class":387},[180,596,577],{"class":185},[180,598,599],{"class":198},"\"Authorization\"",[180,601,195],{"class":185},[180,603,604],{"class":387},"f",[180,606,607],{"class":198},"\"Bearer ",[180,609,577],{"class":191},[180,611,612],{"class":185},"os.environ[",[180,614,615],{"class":198},"'SENDAI_API_KEY'",[180,617,618],{"class":185},"]",[180,620,582],{"class":191},[180,622,623],{"class":198},"\"",[180,625,626],{"class":185},"},\n",[180,628,629],{"class":182,"line":511},[180,630,471],{"class":185},[180,632,634],{"class":182,"line":633},10,[180,635,402],{"emptyLinePlaceholder":81},[180,637,639,642,644,647,650],{"class":182,"line":638},11,[180,640,641],{"class":185},"balances ",[180,643,498],{"class":387},[180,645,646],{"class":185}," res.json()[",[180,648,649],{"class":198},"\"data\"",[180,651,652],{"class":185},"]\n",[180,654,656],{"class":182,"line":655},12,[180,657,658],{"class":514},"# amount is in ten-thousandths: 1250000 == 125.00\n",[167,660,661],{"title":289},[170,662,665],{"className":172,"code":663,"filename":664,"language":175,"meta":176,"style":176},"{\n  \"status\": \"success\",\n  \"message\": \"request successful\",\n  \"data\": [\n    {\n      \"id\": \"5b1c8f2e-3d47-4a09-9c6b-2e8f1a7d4c5e\",\n      \"amount\": 1250000,\n      \"currency\": \"USD\"\n    }\n  ]\n}\n","200 OK",[127,666,667,671,683,695,703,708,719,730,739,744,749],{"__ignoreMap":176},[180,668,669],{"class":182,"line":33},[180,670,186],{"class":185},[180,672,673,676,678,681],{"class":182,"line":49},[180,674,675],{"class":191},"  \"status\"",[180,677,195],{"class":185},[180,679,680],{"class":198},"\"success\"",[180,682,202],{"class":185},[180,684,685,688,690,693],{"class":182,"line":7},[180,686,687],{"class":191},"  \"message\"",[180,689,195],{"class":185},[180,691,692],{"class":198},"\"request successful\"",[180,694,202],{"class":185},[180,696,697,700],{"class":182,"line":21},[180,698,699],{"class":191},"  \"data\"",[180,701,702],{"class":185},": [\n",[180,704,705],{"class":182,"line":38},[180,706,707],{"class":185},"    {\n",[180,709,710,713,715,717],{"class":182,"line":468},[180,711,712],{"class":191},"      \"id\"",[180,714,195],{"class":185},[180,716,199],{"class":198},[180,718,202],{"class":185},[180,720,721,724,726,728],{"class":182,"line":474},[180,722,723],{"class":191},"      \"amount\"",[180,725,195],{"class":185},[180,727,141],{"class":191},[180,729,202],{"class":185},[180,731,732,735,737],{"class":182,"line":479},[180,733,734],{"class":191},"      \"currency\"",[180,736,195],{"class":185},[180,738,223],{"class":198},[180,740,741],{"class":182,"line":511},[180,742,743],{"class":185},"    }\n",[180,745,746],{"class":182,"line":633},[180,747,748],{"class":185},"  ]\n",[180,750,751],{"class":182,"line":638},[180,752,228],{"class":185},[754,755,756],"style",{},"html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}",{"title":176,"searchDepth":49,"depth":49,"links":758},[759,760],{"id":25,"depth":49,"text":24},{"id":28,"depth":49,"text":27},{"title":20,"description":80},"api\u002Fbalances","md",{},1786390038231]