{"id":12101,"date":"2024-06-25T17:50:02","date_gmt":"2024-06-25T15:50:02","guid":{"rendered":"https:\/\/docs.centralpay.com\/documentation\/developpeurs\/utilisation-du-swagger\/"},"modified":"2026-01-13T16:07:31","modified_gmt":"2026-01-13T15:07:31","slug":"utilisation-du-swagger","status":"publish","type":"docs","link":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/","title":{"rendered":"How to use the swagger"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">You&#8217;ll find below instruction to use our swagger properly<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img fetchpriority=\"high\" decoding=\"async\" width=\"1849\" height=\"583\" src=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-12.png\" alt=\"\" class=\"wp-image-12240\" srcset=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-12.png 1849w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-12-300x95.png 300w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-12-1024x323.png 1024w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-12-768x242.png 768w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-12-1536x484.png 1536w\" sizes=\"(max-width: 1849px) 100vw, 1849px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">1 &#8211; This is where you can choose the server you&#8217;ll call for your tests. For now, only RCT (Test Api) is available.<br>2 &#8211; In order to do your tests, you&#8217;ll need to authenticate with your credentials. You can use here your RCT (test) Api login and password. You can also use our test login : Doctest:4I9HJRTd<br>Don&#8217;t use your Production login for the tests, you&#8217;ll get a 401 error.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" width=\"642\" height=\"406\" src=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-09.png\" alt=\"\" class=\"wp-image-12238\" srcset=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-09.png 642w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_10-09-300x190.png 300w\" sizes=\"(max-width: 642px) 100vw, 642px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\"><br>3 &#8211; This is where you will be able to see the parameters for each endpoint, and do your tests.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" width=\"1809\" height=\"1211\" src=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05.png\" alt=\"\" class=\"wp-image-12267\" srcset=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05.png 1809w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05-300x201.png 300w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05-1024x685.png 1024w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05-768x514.png 768w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05-60x40.png 60w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05-1536x1028.png 1536w, https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/2024-06-27_11-05-670x450.png 670w\" sizes=\"(max-width: 1809px) 100vw, 1809px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">4 &#8211; Try it out. Use this if you want to be able to test the endpoint. Make sure you&#8217;re authenticated before doing so.<br>5 &#8211; This is where you&#8217;ll be able to use the test values of your choosing. By default, most values are already filled, but use yours for better results.<br>6 &#8211; Click here once values are filled to call our Api and do your tests.<br>7 &#8211; This is where you&#8217;ll see the results once you called our Api. You&#8217;ll also find here by default responses example for this endpoint.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>You&#8217;ll find below instruction to use our swagger properly 1 &#8211; This is where you can choose the server you&#8217;ll call for your tests. For now, only RCT (Test Api) is available.2 &#8211; In order to do your tests, you&#8217;ll need to authenticate with your credentials. You can use here your RCT (test) Api login [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":12453,"parent":9504,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"doc_badge":[],"class_list":["post-12101","docs","type-docs","status-publish","has-post-thumbnail","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.2 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>How to use the swagger - 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\/developpeurs\/utilisation-du-swagger\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to use the swagger - CentralPay Documentation\" \/>\n<meta property=\"og:description\" content=\"You&#8217;ll find below instruction to use our swagger properly 1 &#8211; This is where you can choose the server you&#8217;ll call for your tests. For now, only RCT (Test Api) is available.2 &#8211; In order to do your tests, you&#8217;ll need to authenticate with your credentials. You can use here your RCT (test) Api login [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/\" \/>\n<meta property=\"og:site_name\" content=\"CentralPay Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2026-01-13T15:07:31+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/icons8-comment-quete-96.png\" \/>\n\t<meta property=\"og:image:width\" content=\"96\" \/>\n\t<meta property=\"og:image:height\" content=\"96\" \/>\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=\"2 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\\\/developpeurs\\\/utilisation-du-swagger\\\/\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/\",\"name\":\"How to use the swagger - CentralPay Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/icons8-comment-quete-96.png\",\"datePublished\":\"2024-06-25T15:50:02+00:00\",\"dateModified\":\"2026-01-13T15:07:31+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/#primaryimage\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/icons8-comment-quete-96.png\",\"contentUrl\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2024\\\/06\\\/icons8-comment-quete-96.png\",\"width\":96,\"height\":96},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/utilisation-du-swagger\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"D\u00e9veloppeurs\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/developpeurs\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"How to use the swagger\"}]},{\"@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":"How to use the swagger - 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\/developpeurs\/utilisation-du-swagger\/","og_locale":"en_US","og_type":"article","og_title":"How to use the swagger - CentralPay Documentation","og_description":"You&#8217;ll find below instruction to use our swagger properly 1 &#8211; This is where you can choose the server you&#8217;ll call for your tests. For now, only RCT (Test Api) is available.2 &#8211; In order to do your tests, you&#8217;ll need to authenticate with your credentials. You can use here your RCT (test) Api login [&hellip;]","og_url":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/","og_site_name":"CentralPay Documentation","article_modified_time":"2026-01-13T15:07:31+00:00","og_image":[{"width":96,"height":96,"url":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/icons8-comment-quete-96.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/","url":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/","name":"How to use the swagger - CentralPay Documentation","isPartOf":{"@id":"https:\/\/docs.centralpay.com\/en\/#website"},"primaryImageOfPage":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/#primaryimage"},"image":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/#primaryimage"},"thumbnailUrl":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/icons8-comment-quete-96.png","datePublished":"2024-06-25T15:50:02+00:00","dateModified":"2026-01-13T15:07:31+00:00","breadcrumb":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/#primaryimage","url":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/icons8-comment-quete-96.png","contentUrl":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2024\/06\/icons8-comment-quete-96.png","width":96,"height":96},{"@type":"BreadcrumbList","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/utilisation-du-swagger\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/docs.centralpay.com\/en\/"},{"@type":"ListItem","position":2,"name":"D\u00e9veloppeurs","item":"https:\/\/docs.centralpay.com\/en\/documentation\/developpeurs\/"},{"@type":"ListItem","position":3,"name":"How to use the swagger"}]},{"@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\/f26ba73d1afc0520e4b1044ff088c0eda58eeaf8c325f16e76f4f944099091cc?s=96&d=mm&r=g","author_name":"Victor","_links":{"self":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/12101","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\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/comments?post=12101"}],"version-history":[{"count":12,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/12101\/revisions"}],"predecessor-version":[{"id":15714,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/12101\/revisions\/15714"}],"up":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/9504"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/media\/12453"}],"wp:attachment":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/media?parent=12101"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/doc_tag?post=12101"},{"taxonomy":"doc_badge","embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/doc_badge?post=12101"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}