{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OrsunPay","description":"Guides, API contracts and workspace walkthroughs for merchants integrating OrsunPay.","colors":{"primary":"#826300","light":"#FFCC00","dark":"#705600"},"logo":{"light":"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/logo-light.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=993e4b5b338d8309f92a9295890ce0b8","dark":"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/logo-dark.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=3f7a25249f226fc3db217801c714262c"},"favicon":"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/favicon.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=2ad7f5317a7cd3fc82e1751839429c8f","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"https://orsunpay.com/contact","label":"Support"}],"primary":{"type":"button","label":"Merchant cabinet","href":"https://r1-cabinet.orsunpay.com"}},"fonts":{"family":"Onest"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orsunpay","hasAudioNarration":false,"actualSubdomain":"orsunpay","customDomains":["docs.orsunpay.com"],"gitSource":{"type":"github","owner":"orsuntech","repo":"orsunpay-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6aed3b9f94899c7f5d7debb7"},"entitlements":{},"buildId":"6aed7a978edba1c7664b50a7","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":54},{"language":"default","tag":"Endpoints","count":53},{"language":"default","tag":"Guides","count":33},{"language":"default","tag":"Cashier player","count":18},{"language":"default","tag":"Usage billing","count":15},{"language":"default","tag":"Server SDKs","count":9},{"language":"default","tag":"Payment methods","count":8},{"language":"default","tag":"Integration essentials","count":6},{"language":"default","tag":"Accept a payment","count":6},{"language":"default","tag":"Manage payments","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/cashier-player/request-a-withdrawal","slug":"/api-reference/cashier-player/request-a-withdrawal","pageMetadata":{"title":"Request a withdrawal","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals","href":"/api-reference/cashier-player/request-a-withdrawal","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Request a withdrawal","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals","href":"/api-reference/cashier-player/request-a-withdrawal","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"CashierWithdrawalController_request","parameters":["dc8458ff-0e80-4203-bb7c-1d489ddf1365","36c3dfea-423e-4035-9554-ca96c631b4f4"],"requestBody":"5255b732-14bd-4efb-80bb-87855b33d2b5","responses":{"200":"7305cf20-d6f4-4a9a-9969-18bdcf6d0ca1","429":"148f9a8a-4af3-49bd-af3c-91a0fc586e56","503":"51394d27-b305-4296-884a-dc7b2dc08755"},"security":["e92be43b-28b5-4cdd-8e56-05f607a2efcf"],"summary":"Request a withdrawal","tags":["Cashier player"],"method":"post","type":"path","servers":[],"path":"/v1/cashier-ui/withdrawals","baseUrlOptions":[],"title":"Request a withdrawal","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dc8458ff-0e80-4203-bb7c-1d489ddf1365":{"in":"header","name":"X-Cashier-Instance-Id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"36c3dfea-423e-4035-9554-ca96c631b4f4":{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"amount":{"example":"25.00","pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"example":"EUR","type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"expectedFee":{"example":"0.50","pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"expectedFee","typeLabel":"string"},"expectedRevision":{"description":"Opaque server quote priceRevision; revalidated before reservation.","type":"string","isRequired":true,"uniqueKey":"expectedRevision","typeLabel":"string"},"expectedTotal":{"example":"25.50","pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"expectedTotal","typeLabel":"string"},"methodChoiceId":{"type":"string","isRequired":true,"uniqueKey":"methodChoiceId","typeLabel":"string"},"crypto":{"properties":{"destinationAddress":{"description":"Bitcoin regtest destination for the B2BinPay sandbox only.","pattern":"^bcrt1q[023456789acdefghjklmnpqrstuvwxyz]{38,58}$","type":"string","isRequired":true,"uniqueKey":"crypto.destinationAddress","typeLabel":"string"},"networkId":{"enum":["BTC"],"type":"string","isRequired":true,"uniqueKey":"crypto.networkId","typeLabel":"enum\u003cstring>"}},"required":["networkId","destinationAddress"],"type":"object","uniqueKey":"crypto","typeLabel":"object"},"quoteId":{"type":"string","uniqueKey":"quoteId","typeLabel":"string"}},"required":["methodChoiceId","amount","currency","expectedRevision","expectedFee","expectedTotal"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":"25.00","currency":"EUR","expectedFee":"0.50","expectedRevision":"\u003cstring>","expectedTotal":"25.50","methodChoiceId":"\u003cstring>","quoteId":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"7305cf20-d6f4-4a9a-9969-18bdcf6d0ca1":{"description":""},"148f9a8a-4af3-49bd-af3c-91a0fc586e56":{"content":{"application/json":{"example":{"error":"RATE_LIMITED","errorCode":"RATE_LIMITED","message":"Too many requests. Retry after the indicated delay.","status":false,"statusCode":429},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"RATE_LIMITED","errorCode":"RATE_LIMITED","message":"Too many requests. Retry after the indicated delay.","status":false,"statusCode":429}}},"exampleType":"examples"}},"description":"RATE_LIMITED: IP, merchant or failed-auth quota exhausted, or auth-in-flight concurrency pressure (Retry-After: 1). Wait Retry-After seconds and retry with the same Idempotency-Key.","headers":{"RateLimit":{"description":"Remaining requests (r) and seconds to reset/full refill (t), per evaluated policy. Absent when disabled; merchant quota is omitted during Redis outages, while IP/auth protection uses replica memory.","schema":{"example":"\"merchant\";r=37;t=4","type":"string"}},"RateLimit-Policy":{"description":"Evaluated policies (draft-ietf-httpapi-ratelimit-headers-11). q is burst quota; w is the full refill window in seconds.","schema":{"example":"\"merchant\";q=100;w=5","type":"string"}},"Retry-After":{"description":"Minimum delay in whole seconds before retrying.","schema":{"example":1,"minimum":1,"type":"integer"}}},"exampleType":"examples"},"51394d27-b305-4296-884a-dc7b2dc08755":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"DUPLICATE_ORDER_ID","errorCode":"DUPLICATE_ORDER_ID","message":"A transaction with orderId \"A-1001\" already exists for this merchant","status":false,"statusCode":409,"existingTransactionId":"tr_x8k2p0q5scocndpejk0nud75q","fields":["customer.email","customer.country"],"idempotencyKey":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","orderId":"A-1001"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"e92be43b-28b5-4cdd-8e56-05f607a2efcf":{"bearer":{"bearerFormat":"Opaque cashier player grant","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"Opaque cashier player grant","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"orsunpay","siteName":"OrsunPay","title":"Request a withdrawal - OrsunPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T06:58:37.214Z","originalFileLocation":"api-reference/cashier-player/request-a-withdrawal.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"OrsunPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Request a withdrawal - OrsunPay\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OrsunPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orsunpay.mintlify.site/_mintlify/api/og/v2?division=Cashier+player\u0026amp;title=Request+a+withdrawal\u0026amp;theme=29e3bf99624baacd33338dc6\u0026amp;signature=3ccabedbacfd12d1282c9160c26d687c8b5f3b2c58913b8a26f70f4f5cdc879c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Request a withdrawal - OrsunPay\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orsunpay.mintlify.site/_mintlify/api/og/v2?division=Cashier+player\u0026amp;title=Request+a+withdrawal\u0026amp;theme=29e3bf99624baacd33338dc6\u0026amp;signature=3ccabedbacfd12d1282c9160c26d687c8b5f3b2c58913b8a26f70f4f5cdc879c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OrsunPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#826300\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cashier-player/request-a-withdrawal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orsunpay.com/#organization\",\"name\":\"OrsunPay\",\"url\":\"https://docs.orsunpay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/logo-light.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=993e4b5b338d8309f92a9295890ce0b8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orsunpay.com#website\",\"name\":\"OrsunPay\",\"url\":\"https://docs.orsunpay.com\",\"publisher\":{\"@id\":\"https://docs.orsunpay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal#webpage\",\"url\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal\",\"name\":\"Request a withdrawal\",\"dateModified\":\"2026-11-06T06:58:37.214Z\",\"isPartOf\":{\"@id\":\"https://docs.orsunpay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.orsunpay.com/api-reference/cashier-player/create-a-crypto-invoice\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cashier player\",\"item\":\"https://docs.orsunpay.com/api-reference/cashier-player/create-a-crypto-invoice\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Request a withdrawal\",\"item\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal#apireference\",\"headline\":\"Request a withdrawal\",\"name\":\"Request a withdrawal\",\"url\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orsunpay.com/api-reference/cashier-player/request-a-withdrawal#webpage\"},\"dateModified\":\"2026-11-06T06:58:37.214Z\",\"publisher\":{\"@id\":\"https://docs.orsunpay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orsunpay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OrsunPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OrsunPay","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Merchant API reference","sidebarTitle":"API overview","href":"/api-overview"}]},{"group":"Endpoints","pages":[{"group":"Cashier player","pages":[{"title":"Create a crypto invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/crypto/invoices","href":"/api-reference/cashier-player/create-a-crypto-invoice"},{"title":"Retrieve a crypto invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/crypto/invoices/{id}","href":"/api-reference/cashier-player/retrieve-a-crypto-invoice"},{"title":"Quote a crypto deposit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/crypto/quote","href":"/api-reference/cashier-player/quote-a-crypto-deposit"},{"title":"List eligible deposit methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/methods","href":"/api-reference/cashier-player/list-eligible-deposit-methods"},{"title":"List cashier operations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/operations","href":"/api-reference/cashier-player/list-cashier-operations"},{"title":"Submit a deposit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/operations","href":"/api-reference/cashier-player/submit-a-deposit"},{"title":"Retrieve a cashier operation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/operations/{id}","href":"/api-reference/cashier-player/retrieve-a-cashier-operation"},{"title":"Quote a deposit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/quote","href":"/api-reference/cashier-player/quote-a-deposit"},{"title":"Refresh cashier authorization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/reauthorize","href":"/api-reference/cashier-player/refresh-cashier-authorization"},{"title":"Read the authenticated player cashier and its currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/session","href":"/api-reference/cashier-player/read-the-authenticated-player-cashier-and-its-currency"},{"title":"Read the immutable presentation pinned when the player session was created","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/template","href":"/api-reference/cashier-player/read-the-immutable-presentation-pinned-when-the-player-session-was-created"},{"title":"List withdrawals","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/withdrawals","href":"/api-reference/cashier-player/list-withdrawals"},{"title":"Request a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals","href":"/api-reference/cashier-player/request-a-withdrawal"},{"title":"List eligible withdrawal methods","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/withdrawals/choices","href":"/api-reference/cashier-player/list-eligible-withdrawal-methods"},{"title":"Quote a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals/quote","href":"/api-reference/cashier-player/quote-a-withdrawal"},{"title":"Retrieve a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/withdrawals/{id}","href":"/api-reference/cashier-player/retrieve-a-withdrawal"},{"title":"Cancel a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals/{id}/cancel","href":"/api-reference/cashier-player/cancel-a-withdrawal"},{"title":"Reconcile a withdrawal reservation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals/{id}/reconcile-reserve","href":"/api-reference/cashier-player/reconcile-a-withdrawal-reservation"}]},{"group":"Cashier embedding policy","pages":[{"title":"Read the stored merchant frame origin; does not authorize a session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/frame-policy/{id}","href":"/api-reference/cashier-embedding-policy/read-the-stored-merchant-frame-origin;-does-not-authorize-a-session"}]},{"group":"Cashier sessions (merchant S2S)","pages":[{"title":"Authorize a player cashier from the merchant backend","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/sessions","href":"/api-reference/cashier-sessions-merchant-s2s/authorize-a-player-cashier-from-the-merchant-backend"},{"title":"Renew player access for the same bound instance","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/sessions/{id}/access-grants","href":"/api-reference/cashier-sessions-merchant-s2s/renew-player-access-for-the-same-bound-instance"},{"title":"Revoke this player cashier immediately","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/sessions/{id}/revoke","href":"/api-reference/cashier-sessions-merchant-s2s/revoke-this-player-cashier-immediately"},{"title":"Acknowledge a wallet effect","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/wallet/receipts","href":"/api-reference/cashier-sessions-merchant-s2s/acknowledge-a-wallet-effect"}]},{"group":"Payments","pages":[{"title":"List payments or find by order ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment","href":"/api-reference/payments/list-payments-or-find-by-order-id"},{"title":"Create withdrawal transaction (Payout)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment/payout","href":"/api-reference/payments/create-withdrawal-transaction-payout"},{"title":"Create deposit transaction (Sale)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment/sale","href":"/api-reference/payments/create-deposit-transaction-sale"},{"title":"Get a payment by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment/{id}","href":"/api-reference/payments/get-a-payment-by-id"}]},{"group":"Payment links","pages":[{"title":"List the authenticated merchant’s links, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-links","href":"/api-reference/payment-links/list-the-authenticated-merchant’s-links-newest-first"},{"title":"Create a merchant-scoped payment link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links","href":"/api-reference/payment-links/create-a-merchant-scoped-payment-link"},{"title":"Get a link owned by the authenticated merchant","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-links/{id}","href":"/api-reference/payment-links/get-a-link-owned-by-the-authenticated-merchant"},{"title":"Permanently deactivate a link; repeated requests are safe","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links/{id}/deactivate","href":"/api-reference/payment-links/permanently-deactivate-a-link;-repeated-requests-are-safe"}]},{"group":"Refunds","pages":[{"title":"List refunds for a payment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment/{id}/refunds","href":"/api-reference/refunds/list-refunds-for-a-payment"},{"title":"Request a full or partial refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment/{id}/refunds","href":"/api-reference/refunds/request-a-full-or-partial-refund"},{"title":"Get a refund","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/refunds/{id}","href":"/api-reference/refunds/get-a-refund"}]},{"group":"Transactions","pages":[{"title":"Poll a merchant transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/transactions/{id}","href":"/api-reference/transactions/poll-a-merchant-transaction"}]},{"group":"Usage billing","pages":[{"title":"Record a usage event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/events","href":"/api-reference/usage-billing/record-a-usage-event"},{"title":"List usage invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/invoices","href":"/api-reference/usage-billing/list-usage-invoices"},{"title":"List usage plans","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/plans","href":"/api-reference/usage-billing/list-usage-plans"},{"title":"Create a usage plan","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/plans","href":"/api-reference/usage-billing/create-a-usage-plan"},{"title":"List usage subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/subscriptions","href":"/api-reference/usage-billing/list-usage-subscriptions"},{"title":"Create a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions","href":"/api-reference/usage-billing/create-a-usage-subscription"},{"title":"Get a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/subscriptions/{id}","href":"/api-reference/usage-billing/get-a-usage-subscription"},{"title":"confirmAutoRenew for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/auto-renew/confirm","href":"/api-reference/usage-billing/confirmautorenew-for-a-usage-subscription"},{"title":"disableAutoRenew for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/auto-renew/disable","href":"/api-reference/usage-billing/disableautorenew-for-a-usage-subscription"},{"title":"setupAutoRenew for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/auto-renew/setup","href":"/api-reference/usage-billing/setupautorenew-for-a-usage-subscription"},{"title":"Cancel a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/cancel","href":"/api-reference/usage-billing/cancel-a-usage-subscription"},{"title":"notifications for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/notifications","href":"/api-reference/usage-billing/notifications-for-a-usage-subscription"},{"title":"paymentHistory for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/subscriptions/{id}/payments/history","href":"/api-reference/usage-billing/paymenthistory-for-a-usage-subscription"},{"title":"recoverPayment for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/payments/recover","href":"/api-reference/usage-billing/recoverpayment-for-a-usage-subscription"},{"title":"Reconcile a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/sync","href":"/api-reference/usage-billing/reconcile-a-usage-subscription"}]},{"group":"Webhooks","pages":[{"title":"Refund failed event","version":null,"deprecated":null,"openapi":"/openapi.json webhook refundFailed","href":"/api-reference/webhooks/refund-failed-event"},{"title":"Refund succeeded event","version":null,"deprecated":null,"openapi":"/openapi.json webhook refundSucceeded","href":"/api-reference/webhooks/refund-succeeded-event"},{"title":"Transaction status event","version":null,"deprecated":null,"openapi":"/openapi.json webhook transactionUpdated","href":"/api-reference/webhooks/transaction-status-event"}]}]}]},{"tab":"Payment methods","pages":[{"title":"Payment methods","href":"/payment-methods"}]},{"tab":"Workspaces","pages":[{"title":"Workspaces","href":"/merchant-cabinet"}]}]},"basePath":"","title":"Request a withdrawal - OrsunPay","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}