The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike Direct Integration, this endpoint does not take a channelId — the customer selects their own payment method on CommercePay’s hosted payment page.
The transaction payment value. This field exclusively accepts integer units where the final decimals are represented as whole values (e.g., an amount value of 1000 translates to 10.00 in the system backend).
Use English letters, numbers, spaces and basic punctuation (. , - _ ( ) @ /). Avoid emojis and non-English characters: some payment providers remove unsupported characters or shorten the text (for example, FPX keeps only the first 30 characters), so the description shown to the customer by the provider may differ from what you sent. The payment is not rejected when characters are removed.
[Conditional] Customer's user agent. It is recommended to input for a better user experience for specific channels due to different platforms such as desktop, mobile, or app view. Example channels impact: ShopeePay.
Target address utilized for asynchronous host-to-host webhook payment status change push actions. See Callback Notifications for the payload and signature verification steps.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CommercePay","colors":{"primary":"#5D40E6","light":"#9546E9","dark":"#5834E9"},"logo":{"light":"https://mintcdn.com/commercepay/zbo4Bt5Hnzxuhmp1/logo/commercepay-logo-cropped.png?fit=max\u0026auto=format\u0026n=zbo4Bt5Hnzxuhmp1\u0026q=85\u0026s=2818942319162624de2b3de633ee42ed","dark":"https://mintcdn.com/commercepay/zbo4Bt5Hnzxuhmp1/logo/commercepay-logo-cropped.png?fit=max\u0026auto=format\u0026n=zbo4Bt5Hnzxuhmp1\u0026q=85\u0026s=2818942319162624de2b3de633ee42ed"},"favicon":"https://mintcdn.com/commercepay/7PrnGTffSwt18xAA/favicon.ico?fit=max\u0026auto=format\u0026n=7PrnGTffSwt18xAA\u0026q=85\u0026s=5bc0f4406b0009f6658b13dd37c95f37","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:payments@commerce.asia","label":"Support"}]},"seo":{"metatags":{"google-site-verification":"dUzHLcHfcaknXY13Nu97zc6gj2DguWeqMvoJWcgBCa4","og:image":"/images/commercepay-og-image.png","twitter:image":"/images/commercepay-og-image.png"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"commercepay","hasAudioNarration":false,"actualSubdomain":"commercepay","customDomains":["docs.commercepay.asia"],"gitSource":{"type":"github","owner":"commerceasia","repo":"commercepay-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae2d375bf78690ab5d17709","collectionId":"968a6a75-68b2-4ecd-bf32-e8fd916b1562","liveDeploymentHistoryId":"6ae2d375bf78690ab5d17709","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae2d375bf78690ab5d17709","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":17},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"All APIs","count":13},{"language":"default","tag":"PaymentGateway","count":10},{"language":"default","tag":"Get Started","count":7},{"language":"default","tag":"Payout APIs","count":3},{"language":"default","tag":"Payins","count":3},{"language":"default","tag":"Payouts","count":3},{"language":"default","tag":"Channel","count":2},{"language":"default","tag":"Payin APIs","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":false},"customCss":[{"filePath":"style.css","content":"img.nav-logo{height:2.25rem!important;width:auto!important}"}],"page":{"pagePath":"api-reference/initial-session","slug":"/api-reference/initial-session","pageMetadata":{"title":"Hosted Session Checkout","description":"Payment gateway hosted session checkout.\r\n\r\nThe following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike [Direct Integration](/api-reference/direct-integration-api-request-payment), this endpoint does not take a `channelId` — the customer selects their own payment method on CommercePay's hosted payment page.","deprecated":null,"version":null,"sidebarTitle":"Hosted Session Checkout","openapi":"/openapi.json post /api/services/app/PaymentGateway/InitialSession","href":"/api-reference/initial-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Payment gateway hosted session checkout.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike \", _jsx(_components.a, {\n href: \"/api-reference/direct-integration-api-request-payment\",\n children: \"Direct Integration\"\n }), \", this endpoint does not take a \", _jsx(_components.code, {\n children: \"channelId\"\n }), \" — the customer selects their own payment method on CommercePay’s hosted payment page.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"Hosted Session Checkout","description":"Payment gateway hosted session checkout.\r\n\r\nThe following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike [Direct Integration](/api-reference/direct-integration-api-request-payment), this endpoint does not take a `channelId` — the customer selects their own payment method on CommercePay's hosted payment page.","deprecated":null,"version":null,"sidebarTitle":"Hosted Session Checkout","openapi":"/openapi.json post /api/services/app/PaymentGateway/InitialSession","href":"/api-reference/initial-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Hosted Session Checkout","tags":["PaymentGateway"],"responses":{"200":"76fd609b-0e60-400e-ba12-a59ecc7d445e","400":"bac5ce6d-f761-441a-bc95-2859bdfc2781"},"operationId":"post-api-services-app-PaymentGateway-InitialSession","description":"Payment gateway hosted session checkout.\r\n\r\nThe following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike [Direct Integration](/api-reference/direct-integration-api-request-payment), this endpoint does not take a `channelId` — the customer selects their own payment method on CommercePay's hosted payment page.","parameters":["884b4ce6-702f-4540-b643-398c63338c7c","5ac12fef-d00e-4e79-9799-3facce1a508f","ae9a11f0-4dd8-4270-b1d3-0e796ab9b0c5"],"requestBody":"96433c19-e462-438a-8de7-a35bb8bfebf3","x-mint":{"href":"/api-reference/initial-session","metadata":{"title":"Hosted Session Checkout","sidebarTitle":"Hosted Session Checkout"}},"method":"post","type":"path","servers":["64f6ba68-f659-4eb6-aced-7af162de9cb4"],"security":[],"path":"/api/services/app/PaymentGateway/InitialSession","baseUrlOptions":["https://staging-payments.commerce.asia"],"title":"Hosted Session Checkout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"884b4ce6-702f-4540-b643-398c63338c7c":{"schema":{"type":"string","isRequired":true,"description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"","typeLabel":"string"},"in":"header","name":"Abp-TenantId","required":true,"description":"Your unique Merchant ID assigned by CommercePay."},"5ac12fef-d00e-4e79-9799-3facce1a508f":{"schema":{"type":"string","isRequired":true,"description":"Your API credentials used for authentication (typically a Bearer token).","uniqueKey":"","typeLabel":"string"},"in":"header","name":"Authorization","required":true,"description":"Your API credentials used for authentication (typically a Bearer token)."},"ae9a11f0-4dd8-4270-b1d3-0e796ab9b0c5":{"schema":{"type":"string","isRequired":true,"description":"A unique security hash used to verify the integrity of the request body. See [Generate Signature](/generate-signature) for how to generate this.","uniqueKey":"","typeLabel":"string"},"in":"header","name":"cap-signature","required":true,"description":"A unique security hash used to verify the integrity of the request body. See [Generate Signature](/generate-signature) for how to generate this."}},"requestBody":{"content":{"application/json":{"schema":{"title":"PaymentSessionInputDto","type":"object","x-examples":{"Example 1":{"currencyCode":"MYR","amount":100,"referenceCode":"string","description":"Order details","ipAddress":"string","userAgent":"string","returnUrl":"https://returnurl.com/","callbackUrl":"https://callback.com/","Customer":{"email":"email@gmail.com","mobileNo":"0123456789","name":"name","username":"username","identificationNumber":"string","identificationType":1},"SubMerchant":{"uniqueId":"string","name":"string"},"PlatformCharge":{"partnerId":"string","amount":0},"virtualAccountCode":"string","RequestPaymentExtraInfo":{"channelGroupId":0,"hiddenChannel":[0]},"expiredInMinutes":15,"tenantId":0,"timestamp":1621851652617}},"required":["currencyCode","amount","referenceCode","description","ipAddress","returnUrl","timestamp"],"properties":{"currencyCode":{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","maxLength":3,"example":"MYR","isRequired":true,"uniqueKey":"currencyCode","typeLabel":"string"},"amount":{"type":"integer","format":"int64","description":"The transaction payment value. This field exclusively accepts integer units where the final decimals are represented as whole values (e.g., an amount value of `1000` translates to `10.00` in the system backend).","example":100,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer\u003cint64>"},"referenceCode":{"type":"string","description":"The merchant-side unique order reference or invoice tracking sequence code.","maxLength":50,"isRequired":true,"uniqueKey":"referenceCode","typeLabel":"string"},"description":{"type":"string","description":"Short free-text summary of the transaction.\n\nUse English letters, numbers, spaces and basic punctuation (`. , - _ ( ) @ /`). Avoid emojis and non-English characters: some payment providers remove unsupported characters or shorten the text (for example, FPX keeps only the first 30 characters), so the description shown to the customer by the provider may differ from what you sent. The payment is not rejected when characters are removed.","example":"Order details","maxLength":100,"isRequired":true,"uniqueKey":"description","typeLabel":"string"},"ipAddress":{"type":"string","description":"The customer's IP address captured by the merchant server.","maxLength":50,"isRequired":true,"uniqueKey":"ipAddress","typeLabel":"string"},"returnUrl":{"type":"string","description":"The synchronous return URL where the customer's browser is automatically redirected after the transaction is completed.","example":"https://returnurl.com/","maxLength":500,"isRequired":true,"uniqueKey":"returnUrl","typeLabel":"string"},"timestamp":{"type":"integer","format":"int64","description":"Numeric timestamp in milliseconds representing request validation freshness, generated via `new Date().getTime()`. Example: `1621851652617`.","example":1621851652617,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"integer\u003cint64>"},"userAgent":{"oneOf":[{"type":"string","description":"**[Conditional]** Customer's user agent. It is recommended to input for a better user experience for specific channels due to different platforms such as desktop, mobile, or app view. Example channels impact: ShopeePay.","maxLength":200,"uniqueKey":"userAgent.oneOf.0","typeLabel":"string"},{"type":"null","description":"**[Conditional]** Customer's user agent. It is recommended to input for a better user experience for specific channels due to different platforms such as desktop, mobile, or app view. Example channels impact: ShopeePay.","maxLength":200,"uniqueKey":"userAgent.oneOf.1","typeLabel":"null"}],"uniqueKey":"userAgent","typeLabel":"string | null"},"callbackUrl":{"oneOf":[{"type":"string","description":"Target address utilized for asynchronous host-to-host webhook payment status change push actions. See [Callback Notifications](/callback-notifications) for the payload and signature verification steps.","maxLength":500,"example":"https://callback.com/","uniqueKey":"callbackUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Target address utilized for asynchronous host-to-host webhook payment status change push actions. See [Callback Notifications](/callback-notifications) for the payload and signature verification steps.","maxLength":500,"example":"https://callback.com/","uniqueKey":"callbackUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"callbackUrl","typeLabel":"string | null"},"Customer":{"type":"object","additionalProperties":false,"properties":{"email":{"oneOf":[{"type":"string","description":"Customer’s Email Address","example":"email@gmail.com","maxLength":150,"uniqueKey":"Customer.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer’s Email Address","example":"email@gmail.com","maxLength":150,"uniqueKey":"Customer.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"Customer.email","typeLabel":"string | null"},"mobileNo":{"oneOf":[{"type":"string","description":"Customer’s Mobile Number","example":"0123456789","maxLength":16,"uniqueKey":"Customer.mobileNo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer’s Mobile Number","example":"0123456789","maxLength":16,"uniqueKey":"Customer.mobileNo.oneOf.1","typeLabel":"null"}],"uniqueKey":"Customer.mobileNo","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Customer’s Name","example":"name","maxLength":36,"uniqueKey":"Customer.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer’s Name","example":"name","maxLength":36,"uniqueKey":"Customer.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"Customer.name","typeLabel":"string | null"},"username":{"oneOf":[{"type":"string","description":"Customer’s unique ID for recurring payments or next saved payments","example":"username","maxLength":36,"uniqueKey":"Customer.username.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer’s unique ID for recurring payments or next saved payments","example":"username","maxLength":36,"uniqueKey":"Customer.username.oneOf.1","typeLabel":"null"}],"uniqueKey":"Customer.username","typeLabel":"string | null"},"identificationNumber":{"oneOf":[{"type":"string","description":"**[Conditional for FPX Recurring]**","uniqueKey":"Customer.identificationNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"**[Conditional for FPX Recurring]**","uniqueKey":"Customer.identificationNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"Customer.identificationNumber","typeLabel":"string | null"},"identificationType":{"enum":[1,2,3,4,5],"type":"integer","x-enumNames":["NewIdentityNumber","OldIdentityNumber","PassportNumber","BusinessRegistration","Others"],"x-examples":{},"description":"**[Conditional for FPX Recurring]**\n\nNew Identity Number = 1, Old Identity Number = 2, Passport Number = 3, Business Registration = 4, Others = 5","uniqueKey":"Customer.identificationType","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"Customer","typeLabel":"object"},"SubMerchant":{"type":"object","properties":{"uniqueId":{"oneOf":[{"type":"string","uniqueKey":"SubMerchant.uniqueId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"SubMerchant.uniqueId.oneOf.1","typeLabel":"null"}],"uniqueKey":"SubMerchant.uniqueId","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"SubMerchant.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"SubMerchant.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"SubMerchant.name","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"SubMerchant","typeLabel":"object"},"PlatformCharge":{"type":"object","additionalProperties":false,"description":"Optional: Only Authorized Partners by CommercePay are allowed to charge platform fees to the merchant","properties":{"partnerId":{"oneOf":[{"type":"string","description":"Unique Id to identify authorized partner.","uniqueKey":"PlatformCharge.partnerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique Id to identify authorized partner.","uniqueKey":"PlatformCharge.partnerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"PlatformCharge.partnerId","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"integer","format":"int64","description":"Platform charge amount.","uniqueKey":"PlatformCharge.amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Platform charge amount.","uniqueKey":"PlatformCharge.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"PlatformCharge.amount","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"PlatformCharge","typeLabel":"object"},"virtualAccountCode":{"oneOf":[{"type":"string","maxLength":30,"description":"Code to identify virtual account to make payment.","uniqueKey":"virtualAccountCode.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":30,"description":"Code to identify virtual account to make payment.","uniqueKey":"virtualAccountCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"virtualAccountCode","typeLabel":"string | null"},"RequestPaymentExtraInfo":{"type":"object","description":"[Optional]","properties":{"ChannelGroupId":{"oneOf":[{"type":"integer","description":"Optional: Used for displaying selected channel groups on CommercePay hosted payment web","format":"int32","uniqueKey":"RequestPaymentExtraInfo.ChannelGroupId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Optional: Used for displaying selected channel groups on CommercePay hosted payment web","format":"int32","uniqueKey":"RequestPaymentExtraInfo.ChannelGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"RequestPaymentExtraInfo.ChannelGroupId","typeLabel":"integer\u003cint32> | null"},"HiddenChannel":{"oneOf":[{"type":"array","description":"Optional: To hide channels on CommercePay hosted payment web","deprecated":true,"items":{"type":"integer","format":"int32","default":0,"uniqueKey":"RequestPaymentExtraInfo.HiddenChannel.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"uniqueKey":"RequestPaymentExtraInfo.HiddenChannel.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","description":"Optional: To hide channels on CommercePay hosted payment web","deprecated":true,"items":{"type":"integer","format":"int32","default":0},"uniqueKey":"RequestPaymentExtraInfo.HiddenChannel.oneOf.1","typeLabel":"null"}],"uniqueKey":"RequestPaymentExtraInfo.HiddenChannel","typeLabel":"integer\u003cint32>[] | null"},"WhitelistChannelGroup":{"oneOf":[{"type":"array","description":"Optional: Specific channel group channel display on the CommercePay hosted payment page.","items":{"type":"integer","format":"int32","uniqueKey":"RequestPaymentExtraInfo.WhitelistChannelGroup.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"uniqueKey":"RequestPaymentExtraInfo.WhitelistChannelGroup.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","description":"Optional: Specific channel group channel display on the CommercePay hosted payment page.","items":{"type":"integer","format":"int32"},"uniqueKey":"RequestPaymentExtraInfo.WhitelistChannelGroup.oneOf.1","typeLabel":"null"}],"uniqueKey":"RequestPaymentExtraInfo.WhitelistChannelGroup","typeLabel":"integer\u003cint32>[] | null"},"WhitelistChannel":{"oneOf":[{"type":"array","description":"Optional: Specific channel display on the CommercePay hosted payment page.","items":{"type":"integer","format":"int32","uniqueKey":"RequestPaymentExtraInfo.WhitelistChannel.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"uniqueKey":"RequestPaymentExtraInfo.WhitelistChannel.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","description":"Optional: Specific channel display on the CommercePay hosted payment page.","items":{"type":"integer","format":"int32"},"uniqueKey":"RequestPaymentExtraInfo.WhitelistChannel.oneOf.1","typeLabel":"null"}],"uniqueKey":"RequestPaymentExtraInfo.WhitelistChannel","typeLabel":"integer\u003cint32>[] | null"}},"uniqueKey":"RequestPaymentExtraInfo","typeLabel":"object"},"expiredInMinutes":{"oneOf":[{"type":"integer","description":"Set the session expired in minutes","example":30,"uniqueKey":"expiredInMinutes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Set the session expired in minutes","example":30,"uniqueKey":"expiredInMinutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiredInMinutes","typeLabel":"integer | null"},"tenantId":{"oneOf":[{"type":"integer","description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"tenantId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"tenantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"tenantId","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"PaymentSessionInputDto · object"},"examples":{"Example":{"title":"Example","value":{"currencyCode":"MYR","amount":100,"referenceCode":"\u003cstring>","description":"Order details","ipAddress":"\u003cstring>","returnUrl":"https://returnurl.com/","timestamp":1621851652617,"userAgent":"\u003cstring>","callbackUrl":"https://callback.com/","Customer":{"email":"email@gmail.com","mobileNo":"0123456789","name":"name","username":"username","identificationNumber":"\u003cstring>"},"SubMerchant":{"uniqueId":"\u003cstring>","name":"\u003cstring>"},"PlatformCharge":{"partnerId":"\u003cstring>","amount":123},"virtualAccountCode":"\u003cstring>","RequestPaymentExtraInfo":{"ChannelGroupId":123,"HiddenChannel":[0],"WhitelistChannelGroup":[123],"WhitelistChannel":[123]},"expiredInMinutes":30,"tenantId":123}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"76fd609b-0e60-400e-ba12-a59ecc7d445e":{"description":"Success","content":{"application/json":{"schema":{"title":"PaymentSessionOutputDto","type":"object","properties":{"redirectionType":{"enum":[1,2,4,5,6],"type":"integer","format":"int32","x-enumNames":["UrlRedirection","RenderScriptRedirection","RenderInQR","CashOnCounterRedirection","RenderInQRBase64"],"description":"How to present the payment to the customer.\n\n| Value | Name | What to do |\n| ----- | ---- | ---------- |\n| 1 | `UrlRedirection` | Redirect the customer's browser to `redirectUrl`. |\n| 2 | `RenderScriptRedirection` | Render `clientScript` in the customer's browser. |\n| 4 | `RenderInQR` | Display `redirectUrl` as a QR code image or link (see `base64Image`). |\n| 5 | `CashOnCounterRedirection` | Show the customer the `serialNumber` to pay at the counter. |\n| 6 | `RenderInQRBase64` | Display the QR code image from `base64Image`. |","uniqueKey":"redirectionType","typeLabel":"enum\u003cinteger>"},"redirectUrl":{"oneOf":[{"type":"string","description":"URL used for the customer to redirect to the payment page","uniqueKey":"redirectUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL used for the customer to redirect to the payment page","uniqueKey":"redirectUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"redirectUrl","typeLabel":"string | null"},"sessionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Session Number","uniqueKey":"sessionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Session Number","uniqueKey":"sessionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionNumber","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"PaymentSessionOutputDto · object"},"examples":{"Example 1":{"title":"Example 1","value":{"redirectionType":1,"redirectUrl":"string","sessionNumber":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"bac5ce6d-f761-441a-bc95-2859bdfc2781":{"description":"Bad Request: \r\nInvalid Timestamp.\r\nInvalid Signature.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"64f6ba68-f659-4eb6-aced-7af162de9cb4":{"description":"Staging","url":"https://staging-payments.commerce.asia"}}},"originalFileLocation":"openapi.json"},"subdomain":"commercepay","siteName":"CommercePay","title":"Hosted Session Checkout - CommercePay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T05:02:49.694Z","originalFileLocation":"api-reference/initial-session.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=\"description\" content=\"Payment gateway hosted session checkout. The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike Direct Integration, this endpoint does not take a channelId — the customer selects their own payment method on CommercePay\u0026#x27;s hosted payment page.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CommercePay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Hosted Session Checkout - CommercePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Payment gateway hosted session checkout. The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike Direct Integration, this endpoint does not take a channelId — the customer selects their own payment method on CommercePay\u0026#x27;s hosted payment page.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CommercePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.commercepay.asia/api-reference/initial-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://commercepay.mintlify.site/images/commercepay-og-image.png\">\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=\"Hosted Session Checkout - CommercePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Payment gateway hosted session checkout. The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike Direct Integration, this endpoint does not take a channelId — the customer selects their own payment method on CommercePay\u0026#x27;s hosted payment page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://commercepay.mintlify.site/images/commercepay-og-image.png\">\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/commercepay/GH8Bb27qvn280PyP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CommercePay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5D40E6\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"dUzHLcHfcaknXY13Nu97zc6gj2DguWeqMvoJWcgBCa4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.commercepay.asia/api-reference/initial-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/initial-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.commercepay.asia/#organization\",\"name\":\"CommercePay\",\"url\":\"https://docs.commercepay.asia\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/commercepay/zbo4Bt5Hnzxuhmp1/logo/commercepay-logo-cropped.png?fit=max\u0026auto=format\u0026n=zbo4Bt5Hnzxuhmp1\u0026q=85\u0026s=2818942319162624de2b3de633ee42ed\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.commercepay.asia#website\",\"name\":\"CommercePay\",\"url\":\"https://docs.commercepay.asia\",\"publisher\":{\"@id\":\"https://docs.commercepay.asia/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.commercepay.asia/api-reference/initial-session#webpage\",\"url\":\"https://docs.commercepay.asia/api-reference/initial-session\",\"name\":\"Hosted Session Checkout\",\"description\":\"Payment gateway hosted session checkout. The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike Direct Integration, this endpoint does not take a channelId — the customer selects their own payment method on CommercePay's hosted payment page.\",\"dateModified\":\"2026-10-29T05:02:49.694Z\",\"isPartOf\":{\"@id\":\"https://docs.commercepay.asia#website\"},\"breadcrumb\":{\"@id\":\"https://docs.commercepay.asia/api-reference/initial-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.commercepay.asia/api-reference/initial-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payin APIs\",\"item\":\"https://docs.commercepay.asia/api-reference/direct-integration-api-request-payment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Hosted Session Checkout\",\"item\":\"https://docs.commercepay.asia/api-reference/initial-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.commercepay.asia/api-reference/initial-session#apireference\",\"headline\":\"Hosted Session Checkout\",\"name\":\"Hosted Session Checkout\",\"description\":\"Payment gateway hosted session checkout. The following input parameters are expected to be provided by the merchant to initiate a hosted checkout session. Unlike Direct Integration, this endpoint does not take a channelId — the customer selects their own payment method on CommercePay's hosted payment page.\",\"url\":\"https://docs.commercepay.asia/api-reference/initial-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.commercepay.asia/api-reference/initial-session#webpage\"},\"image\":\"https://docs.commercepay.asia/images/commercepay-og-image.png\",\"dateModified\":\"2026-10-29T05:02:49.694Z\",\"publisher\":{\"@id\":\"https://docs.commercepay.asia/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.commercepay.asia#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CommercePay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CommercePay","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Get Access Token","deprecated":null,"version":null,"sidebarTitle":"Get Access Token","openapi":"/openapi.json post /api/TokenAuth/Authenticate","href":"/api-reference/get-access-token"}]},{"group":"Channel APIs","pages":[{"title":"Get Channel List","deprecated":null,"version":null,"sidebarTitle":"Get Channel List","openapi":"/openapi.json get /api/services/app/Channel/GetTenantChannelsByCountry","href":"/api-reference/get-tenant-channels-by-country"},{"title":"Get Provider Channels","deprecated":null,"version":null,"sidebarTitle":"Get Provider Channels","openapi":"/openapi.json get /api/services/app/Channel/GetProviderChannels","href":"/api-reference/get-provider-channels"}]},{"group":"Payin APIs","pages":[{"title":"Direct Integration","description":"Initiate a checkout transaction and obtain the payment provider redirection URL.","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/RequestPayment","href":"/api-reference/direct-integration-api-request-payment"},{"title":"Hosted Session Checkout","deprecated":null,"version":null,"sidebarTitle":"Hosted Session Checkout","openapi":"/openapi.json post /api/services/app/PaymentGateway/InitialSession","href":"/api-reference/initial-session"},{"title":"Query Payment","description":"Payment gateway checks the existing payment status.\n\nThe following input parameters are expected to be provided by the merchant to verify transaction status or to obtain more details on the payment before approving the customer’s order.","deprecated":null,"version":null,"sidebarTitle":"Query Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/Query","href":"/api-reference/query-payment"}]},{"group":"Saved Payment APIs","pages":[{"title":"Add Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Add Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/AddSavePayment","href":"/api-reference/add-saved-payment"},{"title":"Check Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Check Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/CheckSavedPayment","href":"/api-reference/check-saved-payment"},{"title":"Revoke Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Revoke Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RevokeTokenize","href":"/api-reference/revoke-saved-payment"}]},{"group":"Payout APIs","pages":[{"title":"Request Payout","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/RequestPayment","href":"/api-reference/payout-api-requestpayout"},{"title":"Query Wallets","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/QueryWallets","href":"/api-reference/payout-api-querywallets"},{"title":"Query Wallet Histories","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/QueryWalletHistory","href":"/api-reference/payout-api-querywallethistories"}]},{"group":"Refund APIs","pages":[{"title":"Refund Payment","deprecated":null,"version":null,"sidebarTitle":"Refund Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RefundPayment","href":"/api-reference/refund-payment"},{"title":"Query Refund Payment","deprecated":null,"version":null,"sidebarTitle":"Query Refund Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/QueryRefund","href":"/api-reference/query-refund-payment"}]},{"group":"All APIs","pages":[{"group":"TokenAuth","pages":[{"title":"Get Access Token","deprecated":null,"version":null,"sidebarTitle":"Get Access Token","openapi":"/openapi.json post /api/TokenAuth/Authenticate","href":"/api-reference/get-access-token"}]},{"group":"Channel","pages":[{"title":"Get Channel List","deprecated":null,"version":null,"sidebarTitle":"Get Channel List","openapi":"/openapi.json get /api/services/app/Channel/GetTenantChannelsByCountry","href":"/api-reference/get-tenant-channels-by-country"},{"title":"Get Provider Channels","deprecated":null,"version":null,"sidebarTitle":"Get Provider Channels","openapi":"/openapi.json get /api/services/app/Channel/GetProviderChannels","href":"/api-reference/get-provider-channels"}]},{"group":"PaymentGateway","pages":[{"title":"Query Payment","deprecated":null,"version":null,"sidebarTitle":"Query Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/Query","href":"/api-reference/query-payment"},{"title":"Request Payment","deprecated":null,"version":null,"sidebarTitle":"Request Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RequestPayment","href":"/api-reference/paymentgateway/request-payment"},{"title":"Process Payment","deprecated":null,"version":null,"sidebarTitle":"Process Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/ProcessPayment","href":"/api-reference/paymentgateway/process-payment"},{"title":"Check Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Check Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/CheckSavedPayment","href":"/api-reference/check-saved-payment"},{"title":"Add Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Add Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/AddSavePayment","href":"/api-reference/add-saved-payment"},{"title":"Revoke Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Revoke Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RevokeTokenize","href":"/api-reference/revoke-saved-payment"},{"title":"Refund Payment","deprecated":null,"version":null,"sidebarTitle":"Refund Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RefundPayment","href":"/api-reference/refund-payment"},{"title":"Query Refund Payment","deprecated":null,"version":null,"sidebarTitle":"Query Refund Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/QueryRefund","href":"/api-reference/query-refund-payment"},{"title":"Query Wallets","description":"Inquiry the wallet balance.\r\n\r\nThe following input parameters are expected to be provided by the merchant to retrieve the wallet balances.","deprecated":null,"version":null,"sidebarTitle":"Query Wallets","openapi":"/openapi.json post /api/services/app/PaymentGateway/QueryWallets","href":"/api-reference/paymentgateway/query-wallets"},{"title":"Hosted Session Checkout","deprecated":null,"version":null,"sidebarTitle":"Hosted Session Checkout","openapi":"/openapi.json post /api/services/app/PaymentGateway/InitialSession","href":"/api-reference/initial-session"}]}]}]}]},"basePath":"","title":"Hosted Session Checkout - CommercePay","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}