Below are essential terms you’ll encounter while integrating Paycashless. Understanding these will help ensure smooth implementation, testing, and reconciliation of transactions.
A private credential used for signing and verifying API requests. You must use your secret to sign requests and validate webhooks for security and integrity.
Paycashless requires all API and webhook requests to be signed using your API Secret. This helps ensure that the request is legitimate and has not been tampered with.
A sandbox environment used during development and testing. It allows developers to simulate payment flows and API interactions without using real money. No actual transactions are processed.
Live
The production environment where real transactions occur. It is used to process actual payments and should only be accessed with secure, verified credentials.
A real-time notification sent to your server when certain events occur (e.g., payment received, settlement completed). You’ll pass a callback URL to receive these.
An embeddable payment UI for websites and apps. Fully brandable and supports “Pay with Transfer” out of the box.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paycashless Docs","colors":{"primary":"#39AD7B","light":"#C4E8DC","dark":"#187261"},"logo":{"light":"https://mintcdn.com/paycashless/xjqjKwekmLoHpVW9/logo/light.svg?fit=max\u0026auto=format\u0026n=xjqjKwekmLoHpVW9\u0026q=85\u0026s=eb78d184cc2fd9eec2b419560c3ccb32","dark":"https://mintcdn.com/paycashless/xjqjKwekmLoHpVW9/logo/dark.svg?fit=max\u0026auto=format\u0026n=xjqjKwekmLoHpVW9\u0026q=85\u0026s=708262842db0258886fd96c7734792cf"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.paycashless.com"}},"footer":{"socials":{"x":"https://x.com/paycashless_","github":"https://github.com/paycashless","linkedin":"https://linkedin.com/company/paycashless"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Guides","icon":"book-open-cover","href":"https://docs.paycashless.com/"},{"anchor":"API Reference","icon":"code","href":"https://docs.paycashless.com/api-reference"},{"anchor":"GitHub","icon":"github","href":"https://github.com/paycashless"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paycashless","hasAudioNarration":false,"actualSubdomain":"paycashless","customDomains":["docs.paycashless.com"],"gitSource":{"type":"github","owner":"paycashless","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91e8d1deeea3b72f9fe56:success","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API reference","count":30},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Invoices","count":6},{"language":"default","tag":"Dedicated Accounts","count":5},{"language":"default","tag":"Payments","count":4},{"language":"default","tag":"Payouts","count":4},{"language":"default","tag":"Tax Rates","count":4},{"language":"default","tag":"API Reference","count":3},{"language":"default","tag":"Online Payments","count":3}]},"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":false},"customCss":[],"page":{"pagePath":"definitions","slug":"/definitions","pageMetadata":{"title":null,"description":null,"href":"/definitions","hidden":false},"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={hr:`hr`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Below are essential terms you’ll encounter while integrating Paycashless. Understanding these will help ensure smooth implementation, testing, and reconciliation of transactions.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication-\u0026-security`,children:`Authentication \u0026 Security`}),`\n`,_jsx(Heading,{level:`4`,id:`api-key`,children:`API Key`}),`\n`,_jsx(_components.p,{children:`A private credential used to authenticate API requests. This key is passed in request headers when calling Paycashless endpoints.`}),`\n`,_jsx(Heading,{level:`4`,id:`api-secret`,children:`API Secret`}),`\n`,_jsx(_components.p,{children:`A private credential used for signing and verifying API requests. You must use your secret to sign requests and validate webhooks for security and integrity.`}),`\n`,_jsx(Heading,{level:`4`,id:`signing-requests`,children:`Signing Requests`}),`\n`,_jsx(_components.p,{children:`Paycashless requires all API and webhook requests to be signed using your API Secret. This helps ensure that the request is legitimate and has not been tampered with.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`environments`,children:`Environments`}),`\n`,_jsx(_components.p,{children:`We have two environments in Paycashless`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Environment`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Details`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.strong,{children:`Test`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`A sandbox environment used during development and testing. It allows developers to simulate payment flows and API interactions without using real money. No actual transactions are processed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.strong,{children:`Live`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The production environment where real transactions occur. It is used to process actual payments and should only be accessed with secure, verified credentials.`})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`payments`,children:`Payments`}),`\n`,_jsx(Heading,{level:`4`,id:`virtual-account`,children:`Virtual Account`}),`\n`,_jsx(_components.p,{children:`A unique bank account number assigned to a business or end-customer, enabling direct transfers and automatic matching of funds.`}),`\n`,_jsx(Heading,{level:`4`,id:`pay-with-transfer`,children:`Pay with Transfer`}),`\n`,_jsx(_components.p,{children:`A payment method that allows customers to complete transactions by transferring funds to a virtual account, instead of using cards.`}),`\n`,_jsx(Heading,{level:`4`,id:`settlement`,children:`Settlement`}),`\n`,_jsx(_components.p,{children:`The transfer of collected funds from Paycashless into your business’s payout account. This typically happens within a configured settlement schedule.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`integration-terms`,children:`Integration Terms`}),`\n`,_jsx(Heading,{level:`4`,id:`webhook`,children:`Webhook`}),`\n`,_jsx(_components.p,{children:`A real-time notification sent to your server when certain events occur (e.g., payment received, settlement completed). You’ll pass a callback URL to receive these.`}),`\n`,_jsx(Heading,{level:`4`,id:`callback-url`,children:`Callback URL`}),`\n`,_jsx(_components.p,{children:`The endpoint on your system where Paycashless sends webhook events. It must be accessible over HTTPS.`}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-environment`,children:`Sandbox Environment`}),`\n`,_jsx(_components.p,{children:`A testing environment with mock data and test keys. Use it to simulate real-world scenarios safely before going live.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`checkout`,children:`Checkout`}),`\n`,_jsx(Heading,{level:`4`,id:`checkout-widget`,children:`Checkout Widget`}),`\n`,_jsx(_components.p,{children:`An embeddable payment UI for websites and apps. Fully brandable and supports “Pay with Transfer” out of the box.`})]})}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":null,"description":null,"href":"/definitions","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication \u0026 Security","slug":"authentication-\u0026-security","depth":2,"children":[{"title":"API Key","slug":"api-key","depth":4,"children":[]},{"title":"API Secret","slug":"api-secret","depth":4,"children":[]},{"title":"Signing Requests","slug":"signing-requests","depth":4,"children":[]}]},{"title":"Environments","slug":"environments","depth":2,"children":[]},{"title":"Payments","slug":"payments","depth":2,"children":[{"title":"Virtual Account","slug":"virtual-account","depth":4,"children":[]},{"title":"Pay with Transfer","slug":"pay-with-transfer","depth":4,"children":[]},{"title":"Settlement","slug":"settlement","depth":4,"children":[]}]},{"title":"Integration Terms","slug":"integration-terms","depth":2,"children":[{"title":"Webhook","slug":"webhook","depth":4,"children":[]},{"title":"Callback URL","slug":"callback-url","depth":4,"children":[]},{"title":"Sandbox Environment","slug":"sandbox-environment","depth":4,"children":[]}]},{"title":"Checkout","slug":"checkout","depth":2,"children":[{"title":"Checkout Widget","slug":"checkout-widget","depth":4,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"paycashless","siteName":"Paycashless Docs","title":"Definitions - Paycashless Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-19T22:40:00.055Z","originalFileLocation":"definitions.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=\"Paycashless Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_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/paycashless/haUtmTUNqeo8HHgm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Definitions - Paycashless Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paycashless Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paycashless.com/definitions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paycashless.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Definitions\u0026amp;theme=0784451bf81bf445a48e5f37\u0026amp;signature=af7e288dcd8e48060b8fa6ef0cb3bc60b9ae42b464e37fcd48d51928a71265e2\">\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=\"Definitions - Paycashless Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paycashless.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Definitions\u0026amp;theme=0784451bf81bf445a48e5f37\u0026amp;signature=af7e288dcd8e48060b8fa6ef0cb3bc60b9ae42b464e37fcd48d51928a71265e2\">\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/paycashless/haUtmTUNqeo8HHgm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paycashless Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#39AD7B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paycashless.com/definitions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/definitions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paycashless.com/#organization\",\"name\":\"Paycashless Docs\",\"url\":\"https://docs.paycashless.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paycashless/xjqjKwekmLoHpVW9/logo/light.svg?fit=max\u0026auto=format\u0026n=xjqjKwekmLoHpVW9\u0026q=85\u0026s=eb78d184cc2fd9eec2b419560c3ccb32\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paycashless.com#website\",\"name\":\"Paycashless Docs\",\"url\":\"https://docs.paycashless.com\",\"publisher\":{\"@id\":\"https://docs.paycashless.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paycashless.com/definitions#webpage\",\"url\":\"https://docs.paycashless.com/definitions\",\"name\":\"Definitions\",\"dateModified\":\"2026-02-19T22:40:00.055Z\",\"isPartOf\":{\"@id\":\"https://docs.paycashless.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paycashless.com/definitions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paycashless.com/definitions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.paycashless.com/home\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Definitions\",\"item\":\"https://docs.paycashless.com/definitions\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.paycashless.com/definitions#article\",\"headline\":\"Definitions\",\"name\":\"Definitions\",\"url\":\"https://docs.paycashless.com/definitions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paycashless.com/definitions#webpage\"},\"dateModified\":\"2026-02-19T22:40:00.055Z\",\"publisher\":{\"@id\":\"https://docs.paycashless.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paycashless.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paycashless Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paycashless Docs","nav":{"global":{"anchors":[{"anchor":"Guides","icon":"book-open-cover","href":"https://docs.paycashless.com/"},{"anchor":"API Reference","icon":"code","href":"https://docs.paycashless.com/api-reference"},{"anchor":"GitHub","icon":"github","href":"https://github.com/paycashless"}]},"tabs":[{"tab":"Guides","groups":[{"group":"Get Started","pages":[{"title":"Welcome to Paycashless's Developer Portal","sidebarTitle":"Home","href":"/home"},{"title":"Create Paycashless account","sidebarTitle":"Create account","href":"/create-account"},{"title":"Getting API credentials","href":"/getting-api-keys"},{"title":"Signing API requests","href":"/api-signature"},{"title":null,"href":"/webhooks"},{"title":null,"description":null,"href":"/webhook-events"},{"title":null,"href":"/definitions"},{"title":null,"description":null,"href":"/use-cases"},{"title":"OpenAPI Specification","href":"/api-specification"}]},{"group":"Online Payments","pages":[{"title":null,"href":"/online-payments/checkout"},{"title":"Pay with transfer","href":"/online-payments/pay-with-transfer"},{"title":null,"href":"/online-payments/payouts"}]}]},{"tab":"API reference","groups":[{"group":"API Reference","pages":[{"title":null,"href":"/api-reference/introduction"},{"title":null,"href":"/api-reference/authentication"},{"title":null,"href":"/api-reference/errors"}]},{"group":"Checkout","pages":[{"title":"Create a checkout link","openapi":"POST /v1/payments/checkout","href":"/api-reference/checkout/create"},{"title":"Sandbox: Simulate checkout transfer","openapi":"POST /v1/simulations/payments/checkout/{id}/transfer","href":"/api-reference/checkout/simulate-checkout-transfer"}]},{"group":"Payments","pages":[{"title":"Initiate a payment","openapi":"POST /v1/payments","href":"/api-reference/payments/initiate"},{"title":"Retrieve a payment","openapi":"GET /v1/payments/{id}","href":"/api-reference/payments/retrieve"},{"title":"Verify a payment","openapi":"GET /v1/payments/{reference}/verify","href":"/api-reference/payments/verify"},{"title":"List all payments","openapi":"GET /v1/payments","href":"/api-reference/payments/list"}]},{"group":"Payouts","pages":[{"title":"Initiate a payout","openapi":"POST /v1/payouts","href":"/api-reference/payouts/initiate"},{"title":"Retrieve a payout","openapi":"GET /v1/payouts/{id}","href":"/api-reference/payouts/retrieve"},{"title":"List all payouts","openapi":"GET /v1/payouts","href":"/api-reference/payouts/list"},{"title":"Verify payout","openapi":"GET /v1/payouts/verify/{reference}","href":"/api-reference/payouts/verify"}]},{"group":"Dedicated Accounts","pages":[{"title":"Create a dedicated account","openapi":"POST /v1/dedicated_accounts","href":"/api-reference/dedicated-accounts/create"},{"title":"Retrieve a dedicated account","openapi":"GET /v1/dedicated_accounts/{id}","href":"/api-reference/dedicated-accounts/retrieve"},{"title":"List all dedicated accounts","openapi":"GET /v1/dedicated_accounts","href":"/api-reference/dedicated-accounts/list"},{"title":"Retrieve account status","openapi":"GET /v1/dedicated_accounts/requests/{code}/status","href":"/api-reference/dedicated-accounts/check-status"},{"title":"Sandbox: Simulate transfer","openapi":"POST /v1/simulations/dedicated_accounts/{id}/transfer","href":"/api-reference/dedicated-accounts/simulate-transfer"}]},{"group":"Invoices","pages":[{"title":"Create an invoice","openapi":"POST /v1/invoices","href":"/api-reference/invoices/create"},{"title":"Retrieve an invoice","openapi":"GET /v1/invoices/{id}","href":"/api-reference/invoices/retrieve"},{"title":"List all invoices","openapi":"GET /v1/invoices","href":"/api-reference/invoices/list"},{"title":"List all invoice payments","openapi":"GET /v1/invoices/{id}/payments","href":"/api-reference/invoices/list-invoice-payments"},{"title":"Cancel an invoice","openapi":"POST /v1/invoices/{id}/cancel","href":"/api-reference/invoices/cancel"},{"title":"Sandbox: Simulate an invoice payment","openapi":"POST /v1/simulations/invoices/{id}/payment","href":"/api-reference/invoices/simulate-invoice-payment"}]},{"group":"Tax Rates","pages":[{"title":"Create a tax rate","openapi":"POST /v1/tax_rates","href":"/api-reference/tax-rates/create"},{"title":"Retrieve a tax rate","openapi":"GET /v1/tax_rates/{id}","href":"/api-reference/tax-rates/retrieve"},{"title":"Update a tax rate","openapi":"PUT /v1/tax_rates/{id}","href":"/api-reference/tax-rates/update"},{"title":"List all tax rates","openapi":"GET /v1/tax_rates","href":"/api-reference/tax-rates/list"}]},{"group":"Miscellaneous","pages":[{"title":"List all banks","openapi":"GET /v1/banks","href":"/api-reference/miscellaneous/list-all-banks"},{"title":"Lookup bank account","openapi":"GET /v1/banks/account_lookup","href":"/api-reference/miscellaneous/account-lookup"}]}]},{"tab":"Changelog","groups":[{"group":"Changelog","pages":[{"title":"Product updates","href":"/changelog"}]}]}]},"basePath":"","title":"Definitions - Paycashless Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":[],"chunks":[]}
