{"templateId":"openapi_docs","versions":[{"version":"v1","label":"v1","link":"/api","default":true,"active":true,"folderId":"702acf7c"},{"version":"v2","label":"v2","link":"/api/v2","default":false,"active":false,"folderId":"702acf7c"}],"sharedDataIds":{"openAPIDocsStore":"oas-api/@v1/index.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"api/@v1/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api","seo":{"title":"Solidgate • API reference","llmstxt":{"sections":[{"title":"API v1","includeFiles":["api/@v1/get-started.md"],"excludeFiles":[]},{"title":"API v2","includeFiles":["api/@v2/get-started.md","api/@v2/md/changelog.md"],"excludeFiles":[]}],"hide":false,"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Solidgate • API reference","description":"The Solidgate API is a payment gateway API that enables merchants to securely process and manage transactions, including card payments and alternative payment methods.\n\n<br>\n\n<p><strong>OpenAPI specification</strong></p>\n<p>Full schema for programmatic integration: endpoint paths, request/response shapes, and field definitions.</p>\n\n<div style=\"display:flex;flex-wrap:wrap;gap:8px;margin-bottom:24px;\">\n\n  <a href=\"/_bundle/api/@v1/index.yaml?download\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <rect x=\"1\" y=\"1\" width=\"12\" height=\"12\" rx=\"1.5\" stroke=\"#fff\" stroke-width=\"0.9\" fill=\"none\"/>\n      <path d=\"M4 4.5L7 7.5L10 4.5M7 7.5V10\" stroke=\"#fff\" stroke-width=\"1.1\" stroke-linecap=\"round\" stroke-linejoin=\"round\" fill=\"none\"/>\n    </svg>\n    YAML\n  </a>\n\n  <a href=\"/_bundle/api/@v1/index.json?download\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M5.5 2C4.3 2 3.8 2.5 3.8 3.8V5.2C3.8 6.2 3.3 6.5 2.3 6.7V7.3C3.3 7.5 3.8 7.8 3.8 8.8V10.2C3.8 11.5 4.3 12 5.5 12\" stroke=\"#fff\" stroke-width=\"1\" stroke-linecap=\"round\" fill=\"none\"/>\n      <path d=\"M8.5 2C9.7 2 10.2 2.5 10.2 3.8V5.2C10.2 6.2 10.7 6.5 11.7 6.7V7.3C10.7 7.5 10.2 7.8 10.2 8.8V10.2C10.2 11.5 9.7 12 8.5 12\" stroke=\"#fff\" stroke-width=\"1\" stroke-linecap=\"round\" fill=\"none\"/>\n    </svg>\n    JSON\n  </a>\n\n</div>\n\n<br>\n\n<p><strong>Get started quickly</strong></p>\n<p>Solidgate offers APIs for processing and managing payments via HTTP/REST or Solidgate libraries, with JSON as the data exchange format.</p>\n\n<div style=\"display:flex;flex-wrap:wrap;gap:8px;margin-bottom:24px;\">\n  <a href=\"https://www.postman.com/solidgate/solidgate-api/overview\" target=\"_blank\" rel=\"noopener noreferrer\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 24 24\" fill=\"none\" style=\"flex-shrink:0;\" aria-hidden=\"true\">\n      <path fill=\"#fff\" d=\"M13.527.099C6.955-.744.942 3.9.099 10.473c-.843 6.572 3.8 12.584 10.373 13.428 6.573.843 12.587-3.801 13.428-10.374C24.744 6.955 20.101.943 13.527.099zm2.471 7.485a.855.855 0 0 0-.593.25l-4.453 4.453-.307-.307-.643-.643c4.389-4.376 5.18-4.418 5.996-3.753zm-4.863 4.861l4.44-4.44a.62.62 0 1 1 .847.903l-4.699 4.125-.588-.588zm.33.694l-1.1.238a.06.06 0 0 1-.067-.032.06.06 0 0 1 .01-.073l.645-.645.512.512zm-2.803-.459l1.172-1.172.879.878-1.979.426a.074.074 0 0 1-.085-.039.072.072 0 0 1 .013-.093zm-3.646 6.058a.076.076 0 0 1-.069-.083.077.077 0 0 1 .022-.046h.002l.946-.946 1.222 1.222-2.123-.147zm2.425-1.256a.228.228 0 0 0-.117.256l.203.865a.125.125 0 0 1-.211.117h-.003l-.934-.934-.294-.295 3.762-3.758 1.82-.393.874.874c-1.255 1.102-2.971 2.201-5.1 3.268zm5.279-3.428h-.002l-.839-.839 4.699-4.125a.952.952 0 0 0 .119-.127c-.148 1.345-2.029 3.245-3.977 5.091zm3.657-6.46l-.003-.002a1.822 1.822 0 0 1 2.459-2.684l-1.61 1.613a.119.119 0 0 0 0 .169l1.247 1.247a1.817 1.817 0 0 1-2.093-.343zm2.578 0a1.714 1.714 0 0 1-.271.218h-.001l-1.207-1.207 1.533-1.533c.661.72.637 1.832-.054 2.522zM18.855 6.05a.143.143 0 0 0-.053.157.416.416 0 0 1-.053.45.14.14 0 0 0 .023.197.141.141 0 0 0 .084.03.14.14 0 0 0 .106-.05.691.691 0 0 0 .087-.751.138.138 0 0 0-.194-.033z\"/>\n    </svg>\n    Postman\n  </a>\n</div>\n\n<br>\n\n<p><strong>Frontend SDK</strong></p>\n<p>These are the primary frontend libraries. Use them to embed payment forms directly in your client-side application.</p>\n\n<div style=\"display:flex;flex-wrap:wrap;gap:8px;margin-bottom:24px;\">\n\n  <a href=\"https://github.com/solidgate-tech/react-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"reactsdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <circle cx=\"7\" cy=\"7\" r=\"1.2\" fill=\"#fff\"/>\n      <ellipse cx=\"7\" cy=\"7\" rx=\"6\" ry=\"2\" stroke=\"#fff\" stroke-width=\"0.9\" fill=\"none\"/>\n      <ellipse cx=\"7\" cy=\"7\" rx=\"6\" ry=\"2\" stroke=\"#fff\" stroke-width=\"0.9\" fill=\"none\" transform=\"rotate(60,7,7)\"/>\n      <ellipse cx=\"7\" cy=\"7\" rx=\"6\" ry=\"2\" stroke=\"#fff\" stroke-width=\"0.9\" fill=\"none\" transform=\"rotate(120,7,7)\"/>\n    </svg>\n    React\n  </a>\n  <a href=\"https://github.com/solidgate-tech/vue-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"vuesdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M1 2L7 12.5L13 2H10.5L7 8L3.5 2Z\" fill=\"#fff\"/>\n      <path d=\"M3.5 2L7 8L10.5 2H8.5L7 5L5.5 2Z\" fill=\"#000\"/>\n    </svg>\n    Vue\n  </a>\n  <a href=\"https://github.com/solidgate-tech/angular-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"angularsdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M7 1L1.5 3L2.5 10.5L7 13.5L11.5 10.5L12.5 3Z\" fill=\"#fff\"/>\n      <path d=\"M7 3.5L4.5 10H5.8L6.4 8.5H7.6L8.2 10H9.5L7 3.5ZM7 5.5L7.3 7.5H6.7Z\" fill=\"#000\"/>\n    </svg>\n    Angular\n  </a>\n</div>\n\n<br>\n\n<p><strong>Backend SDK</strong></p>\n<p>Multiple backend libraries to manage server-side processing, advanced integrations, form resign flows, and reconciling orders.</p>\n\n<div style=\"display:flex;flex-wrap:wrap;gap:8px;\">\n  <a href=\"https://github.com/solidgate-tech/nodejs-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"nodesdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M7 1L13 4.5V9.5L7 13L1 9.5V4.5Z\" stroke=\"#fff\" stroke-width=\"0.9\"/>\n      <text x=\"7\" y=\"8.5\" fill=\"#fff\" font-family=\"Arial,sans-serif\" font-size=\"3.5\" font-weight=\"bold\" text-anchor=\"middle\">JS</text>\n    </svg>\n    Node.js\n  </a>\n  <a href=\"https://github.com/solidgate-tech/php-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"phpsdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <ellipse cx=\"7\" cy=\"7\" rx=\"6\" ry=\"3.5\" stroke=\"#fff\" stroke-width=\"0.9\"/>\n      <text x=\"7\" y=\"8.5\" fill=\"#fff\" font-family=\"Arial,sans-serif\" font-size=\"3.5\" font-weight=\"bold\" text-anchor=\"middle\">php</text>\n    </svg>\n    PHP\n  </a>\n  <a href=\"https://github.com/solidgate-tech/go-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"gosdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M6.5 4C4 4 2.5 5.5 2.5 7C2.5 8.5 4 10 6.5 10V7H4.5\" stroke=\"#fff\" stroke-width=\"0.9\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/>\n      <ellipse cx=\"10.5\" cy=\"7\" rx=\"2\" ry=\"3\" stroke=\"#fff\" stroke-width=\"0.9\"/>\n    </svg>\n    Go\n  </a>\n  <a href=\"https://github.com/solidgate-tech/kotlin-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"kotlinsdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M2 2H12L2 12Z\" fill=\"#fff\"/>\n      <path d=\"M2 12L7 7L12 12Z\" fill=\"#fff\"/>\n    </svg>\n    Kotlin\n  </a>\n  <a href=\"https://github.com/solidgate-tech/python-sdk\" target=\"_blank\" rel=\"noopener noreferrer\" id=\"pythonsdk\" class=\"sg-lang-btn\" style=\"display:inline-flex;align-items:center;gap:5px;background:#000;color:#fff;padding:6px 14px;border-radius:6px;text-decoration:none;font-size:13px;font-family:'Inter',sans-serif;width:96px;justify-content:flex-start;transition:opacity 0.2s ease;\">\n    <svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" fill=\"none\" style=\"flex-shrink:0;\">\n      <path d=\"M7 1C4.5 1 3.5 2 3.5 4V6H7V6.5H4C2.5 6.5 1.5 7.5 1.5 9.5V10.5\" stroke=\"#fff\" stroke-width=\"0.9\" stroke-linecap=\"round\" fill=\"none\"/>\n      <path d=\"M7 13C9.5 13 10.5 12 10.5 10V8H7V7.5H10C11.5 7.5 12.5 6.5 12.5 4.5V3.5\" stroke=\"#fff\" stroke-width=\"0.9\" stroke-linecap=\"round\" fill=\"none\"/>\n      <circle cx=\"5.5\" cy=\"3.5\" r=\"0.6\" fill=\"#fff\"/>\n      <circle cx=\"8.5\" cy=\"10.5\" r=\"0.6\" fill=\"#fff\"/>\n    </svg>\n    Python\n  </a>\n</div>\n\n<div style=\"display:flex; flex-wrap:wrap; gap:8px; margin-top: 20px;\">\n    <p>Enhance understanding with our <a href=\"https://docs.solidgate.com/payments/\" target=\"_blank\">payment guide</a>. <br>\n    For help, write to <a href=\"https://support.solidgate.com/support/tickets/new\" target=\"_blank\">support@solidgate.com.</a></p>\n</div>"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"api-docs.solidgate.com","port":4000,"ipAddress":"216.73.217.59"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}