[{"data":1,"prerenderedAt":742},["ShallowReactive",2],{"navigation-en":3,"en:\u002Fdeposits\u002Fretrieve":193,"en:\u002Fdeposits\u002Fretrieve:surround":737},[4,20,51,77,95,110,133,158,172],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting Started",false,"\u002Fgetting-started","1.getting-started",[10,15],{"title":11,"path":12,"stem":13,"icon":14},"Portal Preparation","\u002Fgetting-started\u002Fportal-setup","1.getting-started\u002F1.portal-setup","i-lucide-rocket",{"title":16,"path":17,"stem":18,"icon":19},"Quickstart","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F2.quickstart","i-lucide-zap",{"title":21,"icon":22,"path":23,"stem":24,"children":25,"page":6},"Core Concepts","i-lucide-key-round","\u002Fconcepts","2.concepts",[26,31,36,41,46],{"title":27,"path":28,"stem":29,"icon":30},"Authentication","\u002Fconcepts\u002Fauthentication","2.concepts\u002F1.authentication","i-lucide-fingerprint",{"title":32,"path":33,"stem":34,"icon":35},"IP Allowlist","\u002Fconcepts\u002Fip-allowlist","2.concepts\u002F2.ip-allowlist","i-lucide-shield-check",{"title":37,"path":38,"stem":39,"icon":40},"Money Format","\u002Fconcepts\u002Fmoney","2.concepts\u002F3.money","i-lucide-banknote",{"title":42,"path":43,"stem":44,"icon":45},"Idempotency","\u002Fconcepts\u002Fidempotency","2.concepts\u002F4.idempotency","i-lucide-repeat",{"title":47,"path":48,"stem":49,"icon":50},"Error envelope & codes","\u002Fconcepts\u002Ferrors","2.concepts\u002F5.errors","i-lucide-octagon-alert",{"title":52,"icon":53,"path":54,"stem":55,"children":56,"page":6},"Deposits","i-lucide-arrow-down-to-line","\u002Fdeposits","3.deposits",[57,62,67,72],{"title":58,"path":59,"stem":60,"icon":61},"Deposit Overview & State Machine","\u002Fdeposits\u002Foverview","3.deposits\u002F1.overview","i-lucide-info",{"title":63,"path":64,"stem":65,"icon":66},"Create a Deposit","\u002Fdeposits\u002Fcreate","3.deposits\u002F2.create","i-lucide-plus",{"title":68,"path":69,"stem":70,"icon":71},"Get a Deposit","\u002Fdeposits\u002Fretrieve","3.deposits\u002F3.retrieve","i-lucide-search",{"title":73,"path":74,"stem":75,"icon":76},"Cancel a Deposit","\u002Fdeposits\u002Fcancel","3.deposits\u002F4.cancel","i-lucide-x",{"title":78,"icon":79,"path":80,"stem":81,"children":82,"page":6},"Withdrawals","i-lucide-arrow-up-from-line","\u002Fwithdrawals","4.withdrawals",[83,87,91],{"title":84,"path":85,"stem":86,"icon":61},"Withdrawal Overview","\u002Fwithdrawals\u002Foverview","4.withdrawals\u002F1.overview",{"title":88,"path":89,"stem":90,"icon":66},"Create a Withdrawal","\u002Fwithdrawals\u002Fcreate","4.withdrawals\u002F2.create",{"title":92,"path":93,"stem":94,"icon":71},"Get & List Withdrawals","\u002Fwithdrawals\u002Fretrieve","4.withdrawals\u002F3.retrieve",{"title":96,"icon":97,"path":98,"stem":99,"children":100,"page":6},"Balance & Banks","i-lucide-wallet","\u002Fbalance","5.balance",[101,105],{"title":102,"path":103,"stem":104,"icon":97},"Get Balance","\u002Fbalance\u002Fget-balance","5.balance\u002F1.get-balance",{"title":106,"path":107,"stem":108,"icon":109},"Bank List","\u002Fbalance\u002Fbanks","5.balance\u002F2.banks","i-lucide-landmark",{"title":111,"icon":112,"path":113,"stem":114,"children":115,"page":6},"Webhooks","i-lucide-webhook","\u002Fwebhooks","6.webhooks",[116,120,125,129],{"title":117,"path":118,"stem":119,"icon":61},"Webhook Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F1.overview",{"title":121,"path":122,"stem":123,"icon":124},"Event Catalog & Payloads","\u002Fwebhooks\u002Fevents","6.webhooks\u002F2.events","i-lucide-list",{"title":126,"path":127,"stem":128,"icon":35},"Signature Verification","\u002Fwebhooks\u002Fsignature-verification","6.webhooks\u002F3.signature-verification",{"title":130,"path":131,"stem":132,"icon":45},"Endpoint Requirements, Retries & SSRF","\u002Fwebhooks\u002Fdelivery-and-retries","6.webhooks\u002F4.delivery-and-retries",{"title":134,"icon":135,"path":136,"stem":137,"children":138,"page":6},"Sandbox","i-lucide-flask-conical","\u002Fsandbox","7.sandbox",[139,143,148,153],{"title":140,"path":141,"stem":142,"icon":61},"Test Mode Overview","\u002Fsandbox\u002Foverview","7.sandbox\u002F1.overview",{"title":144,"path":145,"stem":146,"icon":147},"Simulate Transfer","\u002Fsandbox\u002Fsimulate-transfer","7.sandbox\u002F2.simulate-transfer","i-lucide-banknote-arrow-down",{"title":149,"path":150,"stem":151,"icon":152},"Top-up & Reset","\u002Fsandbox\u002Ftop-up-and-reset","7.sandbox\u002F3.top-up-and-reset","i-lucide-rotate-ccw",{"title":154,"path":155,"stem":156,"icon":157},"End-to-End Test Flow","\u002Fsandbox\u002Fe2e-test-flow","7.sandbox\u002F4.e2e-test-flow","i-lucide-list-checks",{"title":159,"icon":14,"path":160,"stem":161,"children":162,"page":6},"Go-live","\u002Fgo-live","8.go-live",[163,167],{"title":164,"path":165,"stem":166,"icon":157},"Go-live Checklist","\u002Fgo-live\u002Fchecklist","8.go-live\u002F1.checklist",{"title":168,"path":169,"stem":170,"icon":171},"Contact & Support","\u002Fgo-live\u002Fsupport","8.go-live\u002F2.support","i-lucide-life-buoy",{"title":173,"icon":174,"path":175,"stem":176,"children":177,"page":6},"Reference","i-lucide-book-marked","\u002Freference","9.reference",[178,183,188],{"title":179,"path":180,"stem":181,"icon":182},"Endpoint Catalog","\u002Freference\u002Fendpoints","9.reference\u002F1.endpoints","i-lucide-table",{"title":184,"path":185,"stem":186,"icon":187},"Code Samples (Node.js & PHP)","\u002Freference\u002Fcode-samples","9.reference\u002F2.code-samples","i-lucide-code",{"title":189,"path":190,"stem":191,"icon":192},"Status Values & Glossary","\u002Freference\u002Fglossary-states","9.reference\u002F3.glossary-states","i-lucide-book-a",{"id":194,"title":68,"badge":195,"body":196,"description":730,"extension":731,"links":732,"meta":733,"method":732,"navigation":734,"path":69,"seo":735,"stem":70,"__hash__":736},"docs_en\u002F3.deposits\u002F3.retrieve.md","GET",{"type":197,"value":198,"toc":724},"minimark",[199,206,217,222,271,288,292,368,381,385,391,666,670,704,720],[200,201,202],"p",{},[203,204,205],"code",{},"GET \u002Fv1\u002Fdeposits\u002F:id",[200,207,208,209,212,213,216],{},"Use this to fetch a deposit back (e.g. when the payment page refreshes, or to resolve a ",[203,210,211],{},"DEPOSIT_ALREADY_ACTIVE","). It is scoped to your own deposits and the same mode only — a cross-merchant \u002F cross-mode id returns ",[203,214,215],{},"404",". This call is HMAC-signed and bodyless.",[218,219,221],"h2",{"id":220},"behavior","Behavior",[223,224,225,241],"ul",{},[226,227,228,229,232,233,236,237,240],"li",{},"If the deposit is still ",[203,230,231],{},"PENDING",": the response has the same shape as creation — it includes ",[203,234,235],{},"pay_to"," + ",[203,238,239],{},"qr_payload"," (re-derived) so you can re-display the payment instructions.",[226,242,243,244,247,248,247,251,254,255,258,259,262,263,270],{},"If the deposit is terminal (",[203,245,246],{},"CREDITED","\u002F",[203,249,250],{},"EXPIRED",[203,252,253],{},"CANCELLED","): it returns ",[203,256,257],{},"status"," + amounts (e.g. ",[203,260,261],{},"matched_amount"," when credited) but ",[264,265,266,267,269],"strong",{},"no ",[203,268,235],{},"\u002FQR"," anymore (it cannot be paid).",[200,272,273,274,276,277,279,280,279,282,284,285,287],{},"The ",[203,275,257],{}," is one of ",[203,278,231],{},", ",[203,281,246],{},[203,283,250],{},", or ",[203,286,253],{},".",[218,289,291],{"id":290},"example-request","Example request",[293,294,300],"pre",{"className":295,"code":296,"filename":297,"language":298,"meta":299,"style":299},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl 'https:\u002F\u002Fapi.unkpay.co\u002Fv1\u002Fdeposits\u002F8f2b1c4e-7a90-4d2f-9b3a-1c2d3e4f5a6b' \\\n  -H 'X-Api-Key: unk_live_xxxxxxxxxxxx' \\\n  -H 'X-Timestamp: 1718790100' \\\n  -H 'X-Signature: \u003Chex hmac-sha256 over \"GET\\n\u002Fv1\u002Fdeposits\u002F8f2b1c4e...\\n1718790100\\nsha256(empty)\">'\n","cURL","bash","",[203,301,302,326,341,355],{"__ignoreMap":299},[303,304,307,311,315,319,322],"span",{"class":305,"line":306},"line",1,[303,308,310],{"class":309},"sBMFI","curl",[303,312,314],{"class":313},"sMK4o"," '",[303,316,318],{"class":317},"sfazB","https:\u002F\u002Fapi.unkpay.co\u002Fv1\u002Fdeposits\u002F8f2b1c4e-7a90-4d2f-9b3a-1c2d3e4f5a6b",[303,320,321],{"class":313},"'",[303,323,325],{"class":324},"sTEyZ"," \\\n",[303,327,329,332,334,337,339],{"class":305,"line":328},2,[303,330,331],{"class":317},"  -H",[303,333,314],{"class":313},[303,335,336],{"class":317},"X-Api-Key: unk_live_xxxxxxxxxxxx",[303,338,321],{"class":313},[303,340,325],{"class":324},[303,342,344,346,348,351,353],{"class":305,"line":343},3,[303,345,331],{"class":317},[303,347,314],{"class":313},[303,349,350],{"class":317},"X-Timestamp: 1718790100",[303,352,321],{"class":313},[303,354,325],{"class":324},[303,356,358,360,362,365],{"class":305,"line":357},4,[303,359,331],{"class":317},[303,361,314],{"class":313},[303,363,364],{"class":317},"X-Signature: \u003Chex hmac-sha256 over \"GET\\n\u002Fv1\u002Fdeposits\u002F8f2b1c4e...\\n1718790100\\nsha256(empty)\">",[303,366,367],{"class":313},"'\n",[369,370,371],"note",{},[200,372,373,374,377,378,287],{},"For a bodyless\u002FGET request the body hash in the canonical string is the empty-body SHA-256 constant ",[203,375,376],{},"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",". See ",[379,380,27],"a",{"href":28},[218,382,384],{"id":383},"example-response","Example response",[200,386,387,388,390],{},"Example response when ",[203,389,246],{},":",[293,392,396],{"className":393,"code":394,"language":395,"meta":299,"style":299},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": \"8f2b1c4e-7a90-4d2f-9b3a-1c2d3e4f5a6b\",\n  \"amount\": \"500.00\",\n  \"expected_amount\": \"500.37\",\n  \"matched_amount\": \"500.37\",\n  \"currency\": \"THB\",\n  \"status\": \"CREDITED\",\n  \"payment_method_type\": \"PROMPTPAY_QR\",\n  \"payer\": { \"bank\": \"KBANK\", \"account_no\": \"9876543210\", \"name\": \"Somchai Jaidee\" },\n  \"display_expires_at\": \"2026-06-19T10:05:00Z\",\n  \"match_window_until\": \"2026-06-19T10:07:00Z\"\n}\n","json",[203,397,398,403,428,448,468,487,508,527,548,619,640,660],{"__ignoreMap":299},[303,399,400],{"class":305,"line":306},[303,401,402],{"class":313},"{\n",[303,404,405,408,412,415,417,420,423,425],{"class":305,"line":328},[303,406,407],{"class":313},"  \"",[303,409,411],{"class":410},"spNyl","id",[303,413,414],{"class":313},"\"",[303,416,390],{"class":313},[303,418,419],{"class":313}," \"",[303,421,422],{"class":317},"8f2b1c4e-7a90-4d2f-9b3a-1c2d3e4f5a6b",[303,424,414],{"class":313},[303,426,427],{"class":313},",\n",[303,429,430,432,435,437,439,441,444,446],{"class":305,"line":343},[303,431,407],{"class":313},[303,433,434],{"class":410},"amount",[303,436,414],{"class":313},[303,438,390],{"class":313},[303,440,419],{"class":313},[303,442,443],{"class":317},"500.00",[303,445,414],{"class":313},[303,447,427],{"class":313},[303,449,450,452,455,457,459,461,464,466],{"class":305,"line":357},[303,451,407],{"class":313},[303,453,454],{"class":410},"expected_amount",[303,456,414],{"class":313},[303,458,390],{"class":313},[303,460,419],{"class":313},[303,462,463],{"class":317},"500.37",[303,465,414],{"class":313},[303,467,427],{"class":313},[303,469,471,473,475,477,479,481,483,485],{"class":305,"line":470},5,[303,472,407],{"class":313},[303,474,261],{"class":410},[303,476,414],{"class":313},[303,478,390],{"class":313},[303,480,419],{"class":313},[303,482,463],{"class":317},[303,484,414],{"class":313},[303,486,427],{"class":313},[303,488,490,492,495,497,499,501,504,506],{"class":305,"line":489},6,[303,491,407],{"class":313},[303,493,494],{"class":410},"currency",[303,496,414],{"class":313},[303,498,390],{"class":313},[303,500,419],{"class":313},[303,502,503],{"class":317},"THB",[303,505,414],{"class":313},[303,507,427],{"class":313},[303,509,511,513,515,517,519,521,523,525],{"class":305,"line":510},7,[303,512,407],{"class":313},[303,514,257],{"class":410},[303,516,414],{"class":313},[303,518,390],{"class":313},[303,520,419],{"class":313},[303,522,246],{"class":317},[303,524,414],{"class":313},[303,526,427],{"class":313},[303,528,530,532,535,537,539,541,544,546],{"class":305,"line":529},8,[303,531,407],{"class":313},[303,533,534],{"class":410},"payment_method_type",[303,536,414],{"class":313},[303,538,390],{"class":313},[303,540,419],{"class":313},[303,542,543],{"class":317},"PROMPTPAY_QR",[303,545,414],{"class":313},[303,547,427],{"class":313},[303,549,551,553,556,558,560,563,565,568,570,572,574,577,579,582,584,587,589,591,593,596,598,600,602,605,607,609,611,614,616],{"class":305,"line":550},9,[303,552,407],{"class":313},[303,554,555],{"class":410},"payer",[303,557,414],{"class":313},[303,559,390],{"class":313},[303,561,562],{"class":313}," {",[303,564,419],{"class":313},[303,566,567],{"class":309},"bank",[303,569,414],{"class":313},[303,571,390],{"class":313},[303,573,419],{"class":313},[303,575,576],{"class":317},"KBANK",[303,578,414],{"class":313},[303,580,581],{"class":313},",",[303,583,419],{"class":313},[303,585,586],{"class":309},"account_no",[303,588,414],{"class":313},[303,590,390],{"class":313},[303,592,419],{"class":313},[303,594,595],{"class":317},"9876543210",[303,597,414],{"class":313},[303,599,581],{"class":313},[303,601,419],{"class":313},[303,603,604],{"class":309},"name",[303,606,414],{"class":313},[303,608,390],{"class":313},[303,610,419],{"class":313},[303,612,613],{"class":317},"Somchai Jaidee",[303,615,414],{"class":313},[303,617,618],{"class":313}," },\n",[303,620,622,624,627,629,631,633,636,638],{"class":305,"line":621},10,[303,623,407],{"class":313},[303,625,626],{"class":410},"display_expires_at",[303,628,414],{"class":313},[303,630,390],{"class":313},[303,632,419],{"class":313},[303,634,635],{"class":317},"2026-06-19T10:05:00Z",[303,637,414],{"class":313},[303,639,427],{"class":313},[303,641,643,645,648,650,652,654,657],{"class":305,"line":642},11,[303,644,407],{"class":313},[303,646,647],{"class":410},"match_window_until",[303,649,414],{"class":313},[303,651,390],{"class":313},[303,653,419],{"class":313},[303,655,656],{"class":317},"2026-06-19T10:07:00Z",[303,658,659],{"class":313},"\"\n",[303,661,663],{"class":305,"line":662},12,[303,664,665],{"class":313},"}\n",[218,667,669],{"id":668},"error-codes","Error codes",[671,672,673,688],"table",{},[674,675,676],"thead",{},[677,678,679,683,685],"tr",{},[680,681,682],"th",{},"HTTP",[680,684,203],{},[680,686,687],{},"Cause",[689,690,691],"tbody",{},[677,692,693,696,701],{},[694,695,215],"td",{},[694,697,698],{},[203,699,700],{},"NOT_FOUND",[694,702,703],{},"id not found \u002F not yours \u002F cross-mode.",[705,706,707],"tip",{},[200,708,709,710,713,714,717,718,287],{},"Polling this endpoint is for re-displaying instructions and quick UI refreshes. The authoritative terminal result still arrives via the ",[203,711,712],{},"deposit.success"," \u002F ",[203,715,716],{},"deposit.expired"," webhook — see ",[379,719,111],{"href":118},[721,722,723],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}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 .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}",{"title":299,"searchDepth":306,"depth":328,"links":725},[726,727,728,729],{"id":220,"depth":328,"text":221},{"id":290,"depth":328,"text":291},{"id":383,"depth":328,"text":384},{"id":668,"depth":328,"text":669},"GET \u002Fv1\u002Fdeposits\u002F:id — retrieve \u002F poll a deposit; pay_to is present only while PENDING; caller- and mode-scoped","md",null,{},{"icon":71},{"title":68,"description":730},"ARpykiwaqgV8qmJijwwF9N_F_g0tF9b0hJr2MkrHysg",[738,740],{"title":63,"path":64,"stem":65,"description":739,"icon":66,"children":-1},"POST \u002Fv1\u002Fdeposits — create a deposit with HMAC + Idempotency-Key; returns expected_amount and pay_to \u002F qr_payload with status PENDING",{"title":73,"path":74,"stem":75,"description":741,"icon":76,"children":-1},"POST \u002Fv1\u002Fdeposits\u002F:id\u002Fcancel — cancel a still-PENDING deposit and release the amount slot; own + same-mode only",1781891152608]