Welcome to the API reference for Chargily Pay V2, where efficiency and simplicity meet seamless integration.Our API is designed around REST, providing you with a streamlined and predictable experience.Whether you’re in the development phase or ready to go live, our API offers a dual-mode functionality. Utilize the test mode to experiment and fine-tune without impacting your live data or engaging with banking networks. The API URL and the secret key you provide will determine the mode of your request (live or test).
Test Mode Base Url
https://pay.chargily.net/test/api/v2
Live Mode Base Url
https://pay.chargily.net/api/v2
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Chargily Pay Documentation","colors":{"primary":"#5801A2","light":"#12d1fa"},"logo":{"light":"https://mintcdn.com/chargily-78/IvLooWHoSWhCd-iT/logo/light.svg?fit=max\u0026auto=format\u0026n=IvLooWHoSWhCd-iT\u0026q=85\u0026s=54dd666d4c9300866f7484ebbb20261e","dark":"https://mintcdn.com/chargily-78/IvLooWHoSWhCd-iT/logo/dark.svg?fit=max\u0026auto=format\u0026n=IvLooWHoSWhCd-iT\u0026q=85\u0026s=0511d1af3e3499a94b36a75ee58e04b9","href":"http://dz.chargily.com/developer"},"favicon":"/favicon.ico","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://pay.chargily.net/test/api/v2"}},"footer":{"socials":{"github":"http://github.com/chargily","reddit":"http://reddit.com/u/chargily","telegram":"http://t.me/+653KV9zxIxAwNDY0"}},"seo":{"metatags":{"og:title":"Developer Documentation | Chargily for Developers | Chargily Algeria | Chargily","og:description":"APIs, SDKs, docs and open-source resources to integrate payments easily into any platform. Together, we’re building the future of fintech in Algeria.","og:image":"/images/meta-image.webp"},"indexing":"navigable"},"fonts":{"family":"Poppins"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chargily-78","hasAudioNarration":false,"actualSubdomain":"chargily-78","customDomains":["dev.chargily.com"],"gitSource":{"type":"github","owner":"chargilydev","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e614044dd579e9b57151","collectionId":"9bff20e3-b0e1-4099-9309-30d4a3628d43","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e614044dd579e9b57151:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Documentation","count":18},{"language":"default","tag":"Start The Integration","count":9},{"language":"default","tag":"Products","count":7},{"language":"default","tag":"Get Started","count":6},{"language":"default","tag":"Checkouts","count":6},{"language":"default","tag":"Customers","count":6},{"language":"default","tag":"Payment Links","count":6},{"language":"default","tag":"Prices","count":5},{"language":"default","tag":"The Full Guide","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"pay-v2/api-reference/introduction","slug":"/pay-v2/api-reference/introduction","pageMetadata":{"title":"Introduction","og:title":"Introduction | Chargily Pay API - Edahabia API - Satim CIB Web API | Chargily for Developers","description":null,"href":"/pay-v2/api-reference/introduction"},"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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome to the API reference for Chargily Pay V2, where efficiency and simplicity meet seamless integration.`}),`\n`,_jsx(_components.p,{children:`Our API is designed around REST, providing you with a streamlined and predictable experience.`}),`\n`,_jsx(_components.p,{children:`Whether you’re in the development phase or ready to go live, our API offers a dual-mode functionality. Utilize the test mode to experiment and fine-tune without impacting your live data or engaging with banking networks. The API URL and the secret key you provide will determine the mode of your request (live or test).`}),`\n`,_jsx(CodeBlock,{filename:`Test Mode Base Url`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://pay.chargily.net/test/api/v2`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(CodeBlock,{filename:`Live Mode Base Url`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://pay.chargily.net/api/v2`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}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","og:title":"Introduction | Chargily Pay API - Edahabia API - Satim CIB Web API | Chargily for Developers","description":null,"href":"/pay-v2/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"chargily-78","siteName":"Chargily Pay Documentation","title":"Introduction | Chargily Pay API - Edahabia API - Satim CIB Web API | Chargily for Developers","navMaps":{"firstHrefInVersion":{"Chargily Pay V2":{"href":"/pay-v2/api-reference/introduction","matchLevel":0},"Chargily Pro V1":{"href":"/pro-v1/documentation","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-05T11:04:38.589Z","originalFileLocation":"pay-v2/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=\"application-name\" content=\"Chargily Pay Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_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/chargily-78/HpuciM5pKLD22xs-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction | Chargily Pay API - Edahabia API - Satim CIB Web API | Chargily for Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"APIs, SDKs, docs and open-source resources to integrate payments easily into any platform. Together, we’re building the future of fintech in Algeria.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chargily Pay Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.chargily.com/pay-v2/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chargily-78.mintlify.app/images/meta-image.webp\">\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 | Chargily Pay API - Edahabia API - Satim CIB Web API | Chargily for Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"APIs, SDKs, docs and open-source resources to integrate payments easily into any platform. Together, we’re building the future of fintech in Algeria.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chargily-78.mintlify.app/images/meta-image.webp\">\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/chargily-78/HpuciM5pKLD22xs-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chargily Pay Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5801A2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.chargily.com/pay-v2/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=\"/pay-v2/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.chargily.com/#organization\",\"name\":\"Chargily Pay Documentation\",\"url\":\"https://dev.chargily.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chargily-78/IvLooWHoSWhCd-iT/logo/light.svg?fit=max\u0026auto=format\u0026n=IvLooWHoSWhCd-iT\u0026q=85\u0026s=54dd666d4c9300866f7484ebbb20261e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.chargily.com#website\",\"name\":\"Chargily Pay Documentation\",\"url\":\"https://dev.chargily.com\",\"publisher\":{\"@id\":\"https://dev.chargily.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.chargily.com/pay-v2/api-reference/introduction#webpage\",\"url\":\"https://dev.chargily.com/pay-v2/api-reference/introduction\",\"name\":\"Introduction\",\"dateModified\":\"2026-01-05T11:04:38.589Z\",\"isPartOf\":{\"@id\":\"https://dev.chargily.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.chargily.com/pay-v2/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.chargily.com/pay-v2/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Chargily Pay Documentation\",\"item\":\"https://dev.chargily.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://dev.chargily.com/pay-v2/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://dev.chargily.com/pay-v2/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://dev.chargily.com/pay-v2/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://dev.chargily.com/pay-v2/api-reference/introduction#webpage\"},\"image\":\"https://dev.chargily.com/images/meta-image.webp\",\"dateModified\":\"2026-01-05T11:04:38.589Z\",\"publisher\":{\"@id\":\"https://dev.chargily.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.chargily.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chargily Pay Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chargily Pay Documentation","nav":{"global":null,"versions":[{"version":"Chargily Pay V2","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/pay-v2/introduction"}]},{"anchor":"API Reference","icon":"link","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/pay-v2/api-reference/introduction"},{"title":"Authentication","description":null,"href":"/pay-v2/api-reference/authentication"}]},{"group":"Balance","pages":[{"title":"The Balance object","href":"/pay-v2/api-reference/balance/balance-object"},{"title":"Retrieve balance","api":"GET /balance","href":"/pay-v2/api-reference/balance/retrieve-balance"}]},{"group":"Customers","pages":[{"title":"The Customer object","href":"/pay-v2/api-reference/customers/customer-object"},{"title":"Create a customer","api":"POST /customers","href":"/pay-v2/api-reference/customers/create"},{"title":"Update a customer","api":"POST /customers/{id}","href":"/pay-v2/api-reference/customers/update"},{"title":"Retrieve a customer","api":"GET /customers/{id}","href":"/pay-v2/api-reference/customers/retrieve"},{"title":"List all customers","api":"GET /customers","href":"/pay-v2/api-reference/customers/list"},{"title":"Delete a customer","api":"DELETE /customers/{id}","href":"/pay-v2/api-reference/customers/delete"}]},{"group":"Products","pages":[{"title":"The Product object","href":"/pay-v2/api-reference/products/product-object"},{"title":"Create a product","api":"POST /products","href":"/pay-v2/api-reference/products/create"},{"title":"Update a Product","api":"POST /products/{id}","href":"/pay-v2/api-reference/products/update"},{"title":"Retrieve a product","api":"GET /products/{id}","href":"/pay-v2/api-reference/products/retrieve"},{"title":"List all products","api":"GET /products","href":"/pay-v2/api-reference/products/list"},{"title":"Delete a product","api":"DELETE /products/{id}","href":"/pay-v2/api-reference/products/delete"},{"title":"Retrieve a products's prices","api":"GET /products/{id}/prices","href":"/pay-v2/api-reference/products/prices"}]},{"group":"Prices","pages":[{"title":"The Price object","href":"/pay-v2/api-reference/prices/price-object"},{"title":"Create a price","api":"POST /prices","href":"/pay-v2/api-reference/prices/create"},{"title":"Update a price","api":"POST /prices/{id}","href":"/pay-v2/api-reference/prices/update"},{"title":"Retrieve a price","api":"GET /prices/{id}","href":"/pay-v2/api-reference/prices/retrieve"},{"title":"List all prices","api":"GET /prices","href":"/pay-v2/api-reference/prices/list"}]},{"group":"Checkouts","pages":[{"title":"The Checkout object","href":"/pay-v2/api-reference/checkouts/checkout-object"},{"title":"Create a checkout","api":"POST /checkouts","href":"/pay-v2/api-reference/checkouts/create"},{"title":"Retrieve a checkout","api":"GET /checkouts/{id}","href":"/pay-v2/api-reference/checkouts/retrieve"},{"title":"List all checkouts","api":"GET /checkouts","href":"/pay-v2/api-reference/checkouts/list"},{"title":"Retrieve a checkout's items","api":"GET /checkouts/{id}/items","href":"/pay-v2/api-reference/checkouts/items"},{"title":"Expire a checkout","api":"POST /checkouts/{id}/expire","href":"/pay-v2/api-reference/checkouts/expire"}]},{"group":"Payment Links","pages":[{"title":"The Payment Link object","href":"/pay-v2/api-reference/payment-links/payment-link-object"},{"title":"Create a payment link","api":"POST /payment-links","href":"/pay-v2/api-reference/payment-links/create"},{"title":"Update a Payment Link","api":"POST /payment-links/{id}","href":"/pay-v2/api-reference/payment-links/update"},{"title":"Retrieve a payment link","api":"GET /payment-links/{id}","href":"/pay-v2/api-reference/payment-links/retrieve"},{"title":"List all payment links","api":"GET /payment-links","href":"/pay-v2/api-reference/payment-links/list"},{"title":"Retrieve a payment link's items","api":"GET /payment-links/{id}/items","href":"/pay-v2/api-reference/payment-links/items"}]}]},{"anchor":"Community","icon":"telegram","href":"https://t.me/+653KV9zxIxAwNDY0"},{"anchor":"Live Support","icon":"whatsapp","href":"https://chargi.link/WaPay"},{"anchor":"Dashboard","icon":"gauge","href":"http://pay.chargily.com"}]},{"version":"Chargily Pro V1","pages":[{"title":"Chargily Pro V1","href":"/pro-v1/documentation"}]}]},"basePath":"","title":"Introduction | Chargily Pay API - Edahabia API - Satim CIB Web API | Chargily for Developers","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}