{"id":16685,"date":"2024-03-19T16:25:41","date_gmt":"2024-03-19T15:25:41","guid":{"rendered":"https:\/\/docs.centralpay.com\/documentation\/using-the-centralpay-apis\/"},"modified":"2026-09-03T09:24:27","modified_gmt":"2026-09-03T07:24:27","slug":"using-the-centralpay-apis","status":"publish","type":"docs","link":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/","title":{"rendered":"Using the CentralPay APIs"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">The CentralPay APIs allow you to securely interact with our platform to create accounts, initiate payments, or automate business operations.<\/p>\n\n<p class=\"wp-block-paragraph\">Our APIs are based on the HTTP(S) protocol and use a JSON response format. Authentication is required for every request, unless otherwise specified. <\/p>\n\n<h2 class=\"wp-block-heading\">1. Available APIs<\/h2>\n\n<p class=\"wp-block-paragraph\">CentralPay provides two main APIs:<\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>API<\/th><th>Description<\/th><th>Access<\/th><\/tr><\/thead><tbody><tr><td><strong>Core Payment API<\/strong><\/td><td>Manages all functions related to payment transactions (initiation, transfer, refund, etc.)<\/td><td>All merchants<\/td><\/tr><tr><td><strong>API Onboarding<\/strong><\/td><td>Allows users to request the creation of Payment Accounts or Electronic Money Accounts (Enrollment, Wallets, etc.)<\/td><td>Reserved for Partner Merchants and Intermediary Merchants (Agents, EMD).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<h2 class=\"wp-block-heading\">2. Environment URLs<\/h2>\n\n<p class=\"wp-block-paragraph\">Two environments are available, depending on your stage of Integration:<\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Component<\/th><th>Test environment<\/th><th>PRODUCTION Environment<\/th><\/tr><\/thead><tbody><tr><td>Core Payment API<\/td><td><a href=\"https:\/\/test-api.centralpay.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/test-api.centralpay.net\/<\/a><\/td><td><a href=\"https:\/\/api.centralpay.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/api.centralpay.net\/<\/a><\/td><\/tr><tr><td>API Onboarding<\/td><td><a href=\"https:\/\/test-onboarding-api.centralpay.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/test-onboarding-api.centralpay.net\/<\/a><\/td><td><a href=\"https:\/\/onboarding-api.centralpay.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/onboarding-api.centralpay.net\/<\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p class=\"wp-block-paragraph\">The login credentials are different for the test environment and the production environment.<\/p>\n\n<p class=\"wp-block-paragraph\">You can also access your Merchant Portal to view information or configure settings:  <\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Component<\/th><th>Test environment<\/th><th>PRODUCTION Environment<\/th><\/tr><\/thead><tbody><tr><td>Merchant Portal<\/td><td><a href=\"https:\/\/test-backoffice.centralpay.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/test-backoffice.centralpay.net\/<\/a><\/td><td><a href=\"https:\/\/backoffice.centralpay.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/backoffice.centralpay.net\/<\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n<h2 class=\"wp-block-heading\">3. API Authentication<\/h2>\n\n<p class=\"wp-block-paragraph\">The CentralPay API uses HTTP Basic authentication, which requires two mandatory elements to be included in every call:<\/p>\n\n<ul class=\"wp-block-list\">\n<li><strong>API ID (login)<\/strong><\/li>\n\n\n\n<li><strong>API Password<\/strong><\/li>\n<\/ul>\n\n<p class=\"wp-block-paragraph\">All requests must be sent via HTTPS. These credentials are different for the Test environment and production environment. <\/p>\n\n<p class=\"wp-block-paragraph\">To retrieve your API credentials, follow these steps:<\/p>\n\n<h3 class=\"wp-block-heading\">3.1. Step 1 &#8211; Access the Merchant Portal<\/h3>\n\n<ul class=\"wp-block-list\">\n<li>For the <strong>production<\/strong> environment: <a class=\"\" href=\"https:\/\/backoffice.centralpay.net\/\">https:\/\/backoffice.centralpay.net\/<\/a><\/li>\n\n\n\n<li>For the <strong>test<\/strong> environment: <a class=\"\" href=\"https:\/\/test-backoffice.centralpay.net\/\">https:\/\/test-backoffice.centralpay.net\/<\/a><\/li>\n<\/ul>\n\n<h3 class=\"wp-block-heading\">3.2. Step 2 &#8211; Open the technical section<\/h3>\n\n<p class=\"wp-block-paragraph\">From the navigation menu: <strong>Administration<\/strong> &gt; <strong>My Account<\/strong> &gt; <strong>Technical<\/strong><\/p>\n\n<ul class=\"wp-block-list\">\n<li>Direct link to the production version: <a class=\"\" href=\"https:\/\/backoffice.centralpay.net\/admin\/actor\/account#technical_tab\">https:\/\/backoffice.centralpay.net\/admin\/actor\/account#technical_tab<\/a><\/li>\n\n\n\n<li>Direct link (in testing): <a href=\"https:\/\/test-backoffice.centralpay.net\/admin\/actor\/account#technical_tab\">https:\/\/test-backoffice.centralpay.net\/admin\/actor\/account#technical_tab<\/a><\/li>\n<\/ul>\n\n<h3 class=\"wp-block-heading\">3.3. Step 3 &#8211; Retrieve<strong>the API ID (login)<\/strong><\/h3>\n\n<ol class=\"wp-block-list\">\n<li>On the &#8221; <strong>Technical<\/strong>&#8221; tab, locate the &#8220;API ID&#8221; field<\/li>\n\n\n\n<li>Click on the ID shown to view the details<\/li>\n\n\n\n<li>Copy the value shown in the &#8221; <strong>Login<\/strong>&#8221; field<\/li>\n<\/ol>\n\n<p class=\"wp-block-paragraph\">\u26a0\ufe0f This login must be included in the <code>Authorization<\/code> header of your requests (in Base64 format along with the password; see below).<\/p>\n\n<h3 class=\"wp-block-heading\">3.4. Step 4 &#8211; Generate an <strong>API Password<\/strong><\/h3>\n\n<ol class=\"wp-block-list\">\n<li>On the same screen, click the &#8221; <strong>Edit<\/strong>&#8221; button<\/li>\n\n\n\n<li>Then click &#8221; <strong>Generate a password<\/strong>&#8220;<\/li>\n\n\n\n<li>Copy the generated password <strong>immediately<\/strong>; please note that it is <strong>displayed only once<\/strong>.<\/li>\n\n\n\n<li>Finally, click &#8221; <strong>Update<\/strong> &#8221; to confirm the new password<\/li>\n<\/ol>\n\n<p class=\"wp-block-paragraph\">If you forget your password, you&#8217;ll need to repeat this process to generate a new one.<\/p>\n\n<pre class=\"wp-block-preformatted\">\u2139\ufe0f <strong>Best Practices<\/strong>:<br\/>- The username and password can be revoked or regenerated at any time through the Merchant Portal.<br\/>- Never share these credentials in plain text.<br\/>- Store the password in a secure password manager after it has been generated.<\/pre>\n\n<h2 class=\"wp-block-heading\">4. Merchant Public Key (MerchantPublicKey)<\/h2>\n\n<p class=\"wp-block-paragraph\">Some services, such as <code>cardToken<\/code>, do not require a username or password but only a <strong>Merchant public key<\/strong> (<code>MerchantPublicKey<\/code>) to authenticate the request.<\/p>\n\n<p class=\"wp-block-paragraph\"><span style=\"text-decoration: underline;\">Where to find it:<\/span><\/p>\n\n<ul class=\"wp-block-list\">\n<li>Log in to <a class=\"\" href=\"https:\/\/backoffice.centralpay.net\/\">the Production<\/a> or <a href=\"https:\/\/test-backoffice.centralpay.net\/\">Test<\/a> Merchant Portal <\/li>\n\n\n\n<li>Go to: <strong>Administration &gt;, Technical<\/strong><\/li>\n\n\n\n<li>Copy the key into the &#8221; <strong>Merchant Public Key<\/strong>&#8221; section<\/li>\n<\/ul>\n<div class=\"wp-block-image wp-duotone-unset-1\">\n<figure class=\"aligncenter size-large is-resized\"><img fetchpriority=\"high\" decoding=\"async\" width=\"1024\" height=\"533\" src=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-1024x533.png\" alt=\"\" class=\"wp-image-12497\" style=\"width:792px;height:auto\" srcset=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-1024x533.png 1024w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-300x156.png 300w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-768x400.png 768w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-770x400.png 770w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1.png 1423w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n<\/div>\n<h2 class=\"wp-block-heading\">5. HTTP Methods and MIME Types<\/h2>\n\n<p class=\"wp-block-paragraph\">Our APIs follow the REST style and support the following HTTP methods:<\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Method<\/th><th>Usage<\/th><\/tr><\/thead><tbody><tr><td><code>POST<\/code><\/td><td>Creating or Updating an Object<\/td><\/tr><tr><td><code>GET<\/code><\/td><td>Searching for or Viewing an Item<\/td><\/tr><tr><td><code>DELETE<\/code><\/td><td>Deleting an Object<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p class=\"wp-block-paragraph\">The following MIME types are used:<\/p>\n\n<ul class=\"wp-block-list\">\n<li><code>application\/x-www-form-urlencoded<\/code><\/li>\n\n\n\n<li><code>multipart\/form-data<\/code><\/li>\n<\/ul>\n\n<p class=\"wp-block-paragraph\">The <strong>Content-Type<\/strong> must always be specified in the HTTP headers.<\/p>\n\n<h2 class=\"wp-block-heading\">6. HTTP Headers to Use<\/h2>\n\n<p class=\"wp-block-paragraph\">Each API call must include a number of correctly populated HTTP headers:<\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>HTTP Header<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><code>Authorization<\/code><\/td><td>HTTP Basic Authentication Using the API Username and Password<\/td><\/tr><tr><td><code>Content-Type<\/code><\/td><td>Required for all requests. Must be: <code>application\/x-www-form-urlencoded<\/code> or   <code>multipart\/form-data<\/code><\/td><\/tr><tr><td><code>User-Agent<\/code><\/td><td>Highly recommended; useful for plotting integrals<\/td><\/tr><tr><td><code>Idempotence-Key<\/code> <em>(optional but recommended)<\/em><\/td><td>Prevents duplicates when the same request is resubmitted<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<h2 class=\"wp-block-heading\">7. Idempotence: Ensuring Safe Reissuance<\/h2>\n\n<p class=\"wp-block-paragraph\">The ` <code>Idempotence-Key<\/code> ` header ensures that the same request sent multiple times with the <strong>same key<\/strong> will be <strong>processed only once<\/strong>.<\/p>\n\n<p class=\"wp-block-paragraph\">This is particularly useful in the event of a network error or if you are unsure whether a call was successful.<\/p>\n\n<p class=\"wp-block-paragraph\">The value of the ` <code>Idempotence-Key<\/code> ` header is an <strong>SHA1 hash<\/strong> of the request&#8217;s main business fields. It must be <strong>unique for each functional combination<\/strong> of data. Example for a card transaction:  <\/p>\n\n<pre class=\"wp-block-preformatted\">\u2139\ufe0f Idempotence-Key = sha1(card[number] + card[cvc] + card[expirationMonth] + card[expirationYear] + card[check] + merchantPublicKey)<\/pre>\n\n<p class=\"wp-block-paragraph\">The key &#8221; <code>Idempotence-Key<\/code> &#8221; is <strong>valid for<\/strong> up to <strong>24 hours<\/strong> on our servers<\/p>\n\n<h2 class=\"wp-block-heading\">8. HTTP Responses<\/h2>\n\n<p class=\"wp-block-paragraph\">Each response returned by the API contains useful traceability information in the headers:<\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>HTTP Header<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><code>Request-Id<\/code><\/td><td>A unique identifier assigned to each call. This can be provided to CentralPay support in the event of an investigation or technical dispute. <\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p class=\"wp-block-paragraph\">The <strong>JSON response<\/strong> body depends, of course, on the resource being called (payment, transfer, onboarding, etc.), but the ` <code>Request-Id<\/code> ` header is always included.<\/p>\n\n<h2 class=\"wp-block-heading\">9. Registering Your Domains for CustomForm Services<\/h2>\n\n<p class=\"wp-block-paragraph\">For certain services, such as <code>cardToken<\/code>, that rely on <strong>embedded forms (CustomForm)<\/strong>, you must first declare the <strong>web domains<\/strong> that host these forms.<\/p>\n\n<p class=\"wp-block-paragraph\">Without this declaration, any attempt to access the relevant services from an unauthorized domain will result in a <strong>403 (Forbidden) error<\/strong>.<\/p>\n\n<ol class=\"wp-block-list\">\n<li>Log in to the Merchant Portal:\n<ul class=\"wp-block-list\">\n<li><a class=\"\" href=\"https:\/\/backoffice.centralpay.net\/\">Production<\/a><\/li>\n\n\n\n<li><a class=\"\" href=\"https:\/\/test-backoffice.centralpay.net\/\">Test<\/a><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>Go to:\n<ul class=\"wp-block-list\">\n<li><strong>Administration<\/strong> &gt; <strong>My Account<\/strong> &gt; <strong>Technical<\/strong><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>Click &#8221; <strong>Edit<\/strong>&#8220;<\/li>\n\n\n\n<li>In the &#8221; <strong>Allowed Hosts for Custom Forms<\/strong>&#8221; field, enter the URL or domains to allow (e.g., <span style=\"text-decoration: underline;\">https:\/\/www.votre-site.com<\/span>)<\/li>\n\n\n\n<li>Save the changes<\/li>\n<\/ol>\n\n<p class=\"wp-block-paragraph\">Once this step is complete, services such as <code>cardToken<\/code> can be accessed from the registered domains, in accordance with the security rules imposed by CentralPay.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The CentralPay APIs allow you to securely interact with our platform to create accounts, initiate payments, or automate business operations. Our APIs are based on the HTTP(S) protocol and use a JSON response format. Authentication is required for every request, unless otherwise specified. 1. Available APIs CentralPay provides two main APIs: API Description Access Core [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":16728,"menu_order":5,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"doc_badge":[],"class_list":["post-16685","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.5 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Using the CentralPay APIs - CentralPay Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Using the CentralPay APIs - CentralPay Documentation\" \/>\n<meta property=\"og:description\" content=\"The CentralPay APIs allow you to securely interact with our platform to create accounts, initiate payments, or automate business operations. Our APIs are based on the HTTP(S) protocol and use a JSON response format. Authentication is required for every request, unless otherwise specified. 1. Available APIs CentralPay provides two main APIs: API Description Access Core [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/\" \/>\n<meta property=\"og:site_name\" content=\"CentralPay Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2026-09-03T07:24:27+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1423\" \/>\n\t<meta property=\"og:image:height\" content=\"741\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/\",\"name\":\"Using the CentralPay APIs - CentralPay Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/image-1-1024x533.png\",\"datePublished\":\"2024-03-19T15:25:41+00:00\",\"dateModified\":\"2026-09-03T07:24:27+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/#primaryimage\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/image-1-1024x533.png\",\"contentUrl\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/image-1-1024x533.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/using-the-centralpay-apis\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/home\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"General information\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/general-information\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Using the CentralPay APIs\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/\",\"name\":\"CentralPay Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#organization\",\"name\":\"CentralPay Documentation\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2023\\\/07\\\/logo-centralpay-2023.png\",\"contentUrl\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2023\\\/07\\\/logo-centralpay-2023.png\",\"width\":2382,\"height\":370,\"caption\":\"CentralPay Documentation\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Using the CentralPay APIs - CentralPay Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/","og_locale":"en_US","og_type":"article","og_title":"Using the CentralPay APIs - CentralPay Documentation","og_description":"The CentralPay APIs allow you to securely interact with our platform to create accounts, initiate payments, or automate business operations. Our APIs are based on the HTTP(S) protocol and use a JSON response format. Authentication is required for every request, unless otherwise specified. 1. Available APIs CentralPay provides two main APIs: API Description Access Core [&hellip;]","og_url":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/","og_site_name":"CentralPay Documentation","article_modified_time":"2026-09-03T07:24:27+00:00","og_image":[{"width":1423,"height":741,"url":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/","url":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/","name":"Using the CentralPay APIs - CentralPay Documentation","isPartOf":{"@id":"https:\/\/docs.centralpay.com\/en\/#website"},"primaryImageOfPage":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/#primaryimage"},"image":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/#primaryimage"},"thumbnailUrl":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-1024x533.png","datePublished":"2024-03-19T15:25:41+00:00","dateModified":"2026-09-03T07:24:27+00:00","breadcrumb":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/#primaryimage","url":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-1024x533.png","contentUrl":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/image-1-1024x533.png"},{"@type":"BreadcrumbList","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/using-the-centralpay-apis\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/docs.centralpay.com\/en\/home\/"},{"@type":"ListItem","position":2,"name":"General information","item":"https:\/\/docs.centralpay.com\/en\/documentation\/general-information\/"},{"@type":"ListItem","position":3,"name":"Using the CentralPay APIs"}]},{"@type":"WebSite","@id":"https:\/\/docs.centralpay.com\/en\/#website","url":"https:\/\/docs.centralpay.com\/en\/","name":"CentralPay Documentation","description":"","publisher":{"@id":"https:\/\/docs.centralpay.com\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.centralpay.com\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.centralpay.com\/en\/#organization","name":"CentralPay Documentation","url":"https:\/\/docs.centralpay.com\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.centralpay.com\/en\/#\/schema\/logo\/image\/","url":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2023\/07\/logo-centralpay-2023.png","contentUrl":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2023\/07\/logo-centralpay-2023.png","width":2382,"height":370,"caption":"CentralPay Documentation"},"image":{"@id":"https:\/\/docs.centralpay.com\/en\/#\/schema\/logo\/image\/"}}]}},"author_avatar":"https:\/\/secure.gravatar.com\/avatar\/0ab6fa93b0f18fc2235a0e635e81fc14b314e2bb1768930c4ac7606e1f34f470?s=96&d=mm&r=g","author_name":"centralpay_doc","_links":{"self":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16685","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/comments?post=16685"}],"version-history":[{"count":1,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16685\/revisions"}],"predecessor-version":[{"id":16687,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16685\/revisions\/16687"}],"up":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16728"}],"wp:attachment":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/media?parent=16685"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/doc_tag?post=16685"},{"taxonomy":"doc_badge","embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/doc_badge?post=16685"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}