EPayClub provides you with a robust suite of payment APIs. If you are unsure about where to start, see our home page.Set up our APIs in your local environment using our Postman collection.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"EPayClub","description":"Securely send \u0026 receive money using EPayClub.","colors":{"primary":"#3A506B","light":"#6FFFE9","dark":"#3A506B"},"logo":{"light":"https://mintcdn.com/d24/Xy3T6C5xaGQFn9u6/logo/logo.png?fit=max\u0026auto=format\u0026n=Xy3T6C5xaGQFn9u6\u0026q=85\u0026s=1cc12695179b2f3604e8ec9b6f645b14","dark":"https://mintcdn.com/d24/Xy3T6C5xaGQFn9u6/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=Xy3T6C5xaGQFn9u6\u0026q=85\u0026s=a1e1e1a921ca021aab0d8507b3498a83"},"favicon":"https://mintcdn.com/d24/Xy3T6C5xaGQFn9u6/epay-favicon.png?fit=max\u0026auto=format\u0026n=Xy3T6C5xaGQFn9u6\u0026q=85\u0026s=b8f315f2c8d355d110911a3d96991eb6","api":{"mdx":{"auth":{"method":"key","name":"api-key"},"server":"https://checkout-api-service.epayclub.com"}},"background":{"color":{"light":"#ffffff","dark":"#0B132B"}},"navbar":{"links":[{"href":"mailto:support@epayclub.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://merchant.epayclub.com/auth/signin"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"mailto:support@epayclub.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"d24","hasAudioNarration":false,"actualSubdomain":"d24","customDomains":[],"gitSource":{"type":"github","owner":"korneliosyaovi","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92582857703753103ffd7:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":19},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Orders","count":9},{"language":"default","tag":"Payment Links","count":8},{"language":"default","tag":"API Basics","count":4},{"language":"default","tag":"API Documentation","count":4},{"language":"default","tag":"Payments","count":3},{"language":"default","tag":"Payment Operations","count":1},{"language":"default","tag":"Get Started","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"Basic information on API specifications.","href":"/api-reference/introduction","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Basic information on API specifications.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`Our APIs are RESTful and follow the basics of HTTPS protocol.`})}),`\n`,_jsx(Heading,{level:`2`,id:`welcome`,children:`Welcome`}),`\n`,_jsx(_components.p,{children:`EPayClub provides you with a robust suite of payment APIs. If you are unsure about where to start, see our home page.`}),`\n`,_jsxs(_components.p,{children:[`Set up our APIs in your local environment using our `,_jsx(_components.a,{href:`https://elements.getpostman.com/view/import?collection=10904236-5a4512a1-25db-4aad-9bd8-14949a955e1a-2sAYQfEV6P\u0026\u0026referrer=https%3A%2F%2Fdocumenter.getpostman.com%2Fview%2F10904236%2F2sAYQfEV6P\u0026versionTag=latest\u0026source=documenter`,children:`Postman collection`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Basic information on API specifications.","href":"/api-reference/introduction","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"d24","siteName":"EPayClub","title":"Introduction - EPayClub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-11T03:41:42.415Z","originalFileLocation":"api-reference/introduction.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=\"Basic information on API specifications.\">\u003cmeta data-mint-head name=\"application-name\" content=\"EPayClub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_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/d24/7t5pvBDb5JPrg6Mx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - EPayClub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Basic information on API specifications.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"EPayClub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://d24.mintlify.app/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://d24.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=Basic+information+on+API+specifications.\u0026amp;theme=4af581eb591682bd71cfb619\u0026amp;signature=96b4b6117aca8e257e2bd8b82eb6c97adb29fed6eefb68e33e8bf0878b20ffcd\">\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=\"Introduction - EPayClub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Basic information on API specifications.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://d24.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=Basic+information+on+API+specifications.\u0026amp;theme=4af581eb591682bd71cfb619\u0026amp;signature=96b4b6117aca8e257e2bd8b82eb6c97adb29fed6eefb68e33e8bf0878b20ffcd\">\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/d24/7t5pvBDb5JPrg6Mx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"EPayClub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3A506B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://d24.mintlify.app/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://d24.mintlify.app/#organization\",\"name\":\"EPayClub\",\"url\":\"https://d24.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/d24/Xy3T6C5xaGQFn9u6/logo/logo.png?fit=max\u0026auto=format\u0026n=Xy3T6C5xaGQFn9u6\u0026q=85\u0026s=1cc12695179b2f3604e8ec9b6f645b14\"}},{\"@type\":\"WebSite\",\"@id\":\"https://d24.mintlify.app#website\",\"name\":\"EPayClub\",\"url\":\"https://d24.mintlify.app\",\"publisher\":{\"@id\":\"https://d24.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://d24.mintlify.app/api-reference/introduction#webpage\",\"url\":\"https://d24.mintlify.app/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"Basic information on API specifications.\",\"dateModified\":\"2025-11-11T03:41:42.415Z\",\"isPartOf\":{\"@id\":\"https://d24.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://d24.mintlify.app/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://d24.mintlify.app/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"EPayClub\",\"item\":\"https://d24.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://d24.mintlify.app/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://d24.mintlify.app/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Basic information on API specifications.\",\"url\":\"https://d24.mintlify.app/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://d24.mintlify.app/api-reference/introduction#webpage\"},\"dateModified\":\"2025-11-11T03:41:42.415Z\",\"publisher\":{\"@id\":\"https://d24.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://d24.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"EPayClub\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"EPayClub","nav":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"mailto:support@epayclub.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"API Headers","description":"Learn about our API request headers","href":"/api-reference/headers"},{"title":"API Errors","href":"/api-reference/errors"},{"title":"API Glossary","href":"/api-reference/api-glossary"}]},{"group":"Orders","pages":[{"title":"Create Orders","api":"POST /checkout/order/create","href":"/api-reference/orders/create"},{"title":"Query Order fee","api":"POST /checkout/order/fee","href":"/api-reference/orders/fee"},{"title":"Pay Order","api":"POST /checkout/order/pay","href":"/api-reference/orders/pay"},{"title":"Query Order Status","api":"POST /checkout/order/status","href":"/api-reference/orders/order-status"},{"title":"Verify Order","api":"POST /checkout/order/verify","href":"/api-reference/orders/verify-order"},{"title":"Retrieve Transaction Timeline","api":"POST /checkout/order/event/track","href":"/api-reference/orders/timeline"}]},{"group":"Payment Operations","pages":[{"title":"Query Bank Codes","api":"GET /checkout/banks","href":"/api-reference/payment-operations/bank-codes"}]},{"group":"Payment Links","pages":[{"title":"Create Payment Links","api":"POST /checkout/links/create","href":"/api-reference/payment-link/create-link"},{"title":"Fetch Payment Links","api":"GET /checkout/links/all","href":"/api-reference/payment-link/fetch-links"},{"title":"Fetch Supported Link types","api":"GET /checkout/links/types","href":"/api-reference/payment-link/fetch-link-type"},{"title":"Edit Payment Link","api":"PATCH /checkout/links/{id}/edit","href":"/api-reference/payment-link/edit-link"},{"title":"Activate Payment link","api":"PATCH /checkout/links/{id}/status/activate","href":"/api-reference/payment-link/activate-link"},{"title":"Deactivate Payment link","api":"PATCH /checkout/links/{id}/status/disable","href":"/api-reference/payment-link/deactivate-link"},{"title":"Cancel Recurring Payment","api":"PATCH /checkout/links/recurringpayment/{id}/cancel","href":"/api-reference/payment-link/cancel-recurring-payments"},{"title":"Fetch Link frequencies","api":"GET /checkout/frequencies","href":"/api-reference/payment-link/fetch-frequencies"}]}]}]},"basePath":"","title":"Introduction - EPayClub","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":[],"chunks":[]}
